@reykjavik/webtools 0.3.11 → 0.3.13

package/CHANGELOG.md

@@ -4,14 +4,22 @@
 
 - ... <!-- Add new lines here. -->
 
-## 0.3.11
+## 0.3.13
 
-_2026-03-16_
+_2026-03-17_
+
+- `@reykjavik/webtools/alertsStore`:
+  - feat: Add "message-only" shorthand signature to alerter dispatcher methods
+
+## 0.3.12
+
+_2026-03-17_
 
-- `@reykjavik/webtools/alertsStore/react`:
-  - feat: Support rendering `br` and `em` elements in alert messages
+- `@reykjavik/webtools/alertsStore`:
+  - feat: Make alert `type` property disabled by default, enabled via config
+  - feat: Add `AlerterConfig.title?:boolean` to enable optional alert `title`s
 
-## 0.3.7 – 0.3.10
+## 0.3.7 – 0.3.11
 
 _2026-03-16_
 

package/README.md

@@ -1032,20 +1032,46 @@ setTimeout(unsubscribe, 3_600_000);
 import { alerter } from '../alerterStore';
 alerter.success({
   message: 'All is good',
-  // type: 'something',
   // flags: ['pristine'],
   duration: 'MEDIUM',
-  delay: 500, // Optional delay
+  delay: 500, // Optional delay in milliseconds
 });
-// after 500ms the above alert is added to the store, and all subscribers
-// are notified. The subscriber in `appRoot.ts` will log the following;
+alerter.info('Simple message!'); // Shorthand syntax
+
+// On the next event loop tick the "info" alert (with no delay) is emitted, and all
+// subscribers are notified. The subscriber in `appRoot.ts` will log the following;
+/*
+  Current alerts: [
+    {
+      id: '_234566-28_', // auto-generated
+      level: 'info',
+      message: 'Simple message!',
+      duration: 5000, // ms
+      dismiss: <Function>,
+      setFalgs: <Function>,
+    }
+  ]
+  Change type: 'add'
+  Affected alert IDs: ['_234566-28_']
+*/
+
+// Then after 500ms the "success" alert is added to the store, and all subscribers
+// are notified again. The subscriber in `appRoot.ts` will log the following;
 /*
   Current alerts: [
     {
-      id: '_234566-27_', // autugenerated
+      id: '_234566-28_',
+      level: 'info',
+      message: 'Simple message!',
+      duration: 5000, // ms
+      dismiss: <Function>,
+      setFalgs: <Function>,
+    },
+    {
+      id: '_234566-27_',
       level: 'success',
       message: 'All is good',
-      duration: 5000, // ms
+      duration: 5000,
       dismiss: <Function>,
       setFalgs: <Function>,
     }
@@ -1086,7 +1112,11 @@ The configuration options are as follows:
   The allowed alert "types", which can be used to, for example, dispatch both
   "toasts" vs. "static alert banners" via the same store.  
   This can also be used for more basic styling or categorization purposes.  
-  Default: no restrictions, any string value is allowed.
+  Default: `[ ]` (No types and the `type` property not allowed).
+
+- **`title?: boolean`**  
+  Whether to allow an optional `title` property on alerts.  
+  Default: `false`.
 
 - **`flags?: Array<string>`**  
   The allowed alert "flags", which can be changed during the lifetime of an

package/alertsStore/index.d.ts

@@ -13,14 +13,6 @@ declare const messageSchema: v.UnionSchema<[v.StringSchema<undefined>, v.ArraySc
     readonly text: v.StringSchema<undefined>;
 }, undefined>], undefined>, undefined>], undefined>;
 export type AlertMessage = v.InferOutput<typeof messageSchema>;
-type _AlertNotification<Level, Type, Flag> = {
-    level: Level;
-    message: AlertMessage;
-    type?: Type;
-    flags?: Array<Flag>;
-    duration?: number;
-    id: string;
-};
 declare const defaultAlertLevels: readonly ["info", "warning", "success", "error"];
 declare const defaultDurations: {
     BLINK: number;
@@ -36,7 +28,7 @@ declare const defaultDurations: {
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#type-alerterconfig
  */
-export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Duration extends string = keyof typeof defaultDurations, Durations extends Record<Duration, number> = Record<Duration, number>> = {
+export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Title extends boolean = false, Duration extends string = keyof typeof defaultDurations, Durations extends Record<Duration, number> = Record<Duration, number>> = {
     /**
      * Identifier for the alerts store, used to create the key to persist alerts
      * in `sessionStorage` (or other provided storage).
@@ -60,7 +52,7 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
      *
      * This can also be used for more basic styling or categorization purposes.
      *
-     * Default: no restrictions, any string value is allowed.
+     * Default: `[ ]`  (No types and the `type` property not allowed).
      */
     types?: Array<Type>;
     /**
@@ -97,6 +89,12 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
      * is `0` (indefinite)
      */
     defaultDuration?: Durations extends Record<infer D, number> ? D : never;
+    /**
+     * Whether to allow an optional `title` property on alerts.
+     *
+     * Default: `false`.
+     */
+    title?: Title;
     /**
      * Optional custom storage object to use instead of `sessionStorage` (the
      * default) for persisting alerts across page reloads, etc.
@@ -112,7 +110,7 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
  */
-export declare const createAlerterStore: <Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Duration extends string = keyof typeof defaultDurations>(cfg?: AlerterConfig<Level, Type, Flag, Duration>) => {
+export declare const createAlerterStore: <Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Title extends boolean = false, Duration extends string = keyof typeof defaultDurations>(cfg?: AlerterConfig<Level, Type, Flag, Title, Duration>) => {
     /**
      * Singleton object with methods for showing alerts of different levels.
      * Pass a payload object to the method of the level you want to dispatch,
@@ -123,7 +121,7 @@ export declare const createAlerterStore: <Level extends string = (typeof default
      *
      * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
      */
-    alerter: Record<Level, (payload: {
+    alerter: Record<Level, (payload: AlertMessage | ({
         /**
          * A simple string containing the alert message.
          *
@@ -135,13 +133,6 @@ export declare const createAlerterStore: <Level extends string = (typeof default
          * them.)
          */
         message: AlertMessage;
-        /**
-         * Allows distinguishing between different "types" of alerts, for example,
-         * to dispatch both "toasts" vs. "static alert banners" via the same store.
-         *
-         * May also be used for more basic styling or categorization purposes.
-         */
-        type?: Type;
         /**
          * Flag values can be changed during the lifetime of
          * an alert using the `setFlags` function on each `AlertInfo` object.
@@ -159,7 +150,20 @@ export declare const createAlerterStore: <Level extends string = (typeof default
          */
         duration?: Duration;
         delay?: number;
-    }) => void>;
+    } & (Title extends true ? {
+        /**
+         * Optional title to accompany the alert message.
+         */
+        title?: string;
+    } : unknown) & (string extends Type ? unknown : {
+        /**
+         * Allows distinguishing between different "types" of alerts, for example,
+         * to dispatch both "toasts" vs. "static alert banners" via the same store.
+         *
+         * May also be used for more basic styling or categorization purposes.
+         */
+        type?: Type;
+    }))) => void>;
     /**
      * Subscribes to alert events. The provided callback will be called whenever a
      * alert is added or cleared.
@@ -172,7 +176,17 @@ export declare const createAlerterStore: <Level extends string = (typeof default
      *
      * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
      */
-    subscribe: (callback: (notifications: Array<_AlertNotification<Level, Type, Flag> & {
+    subscribe: (callback: (notifications: Array<{
+        level: Level;
+        message: AlertMessage;
+        flags?: Flag[] | undefined;
+        duration?: number;
+        id: string;
+    } & (Title extends true ? {
+        title?: string;
+    } : unknown) & (string extends Type ? unknown : {
+        type?: Type | undefined;
+    }) & {
         /** Dispatcher function that dismisses/hides/removes the callback */
         dismiss: () => void;
         /**

package/alertsStore/index.js

@@ -95,8 +95,9 @@ const createAlerterStore = (cfg = {}) => {
         : defaultDefaultDuration;
     const _notificationSchema = v.object({
         level: v.picklist(alertLevels),
+        title: cfg.title ? v.optional(v.string()) : v.never(),
         message: messageSchema,
-        type: v.optional(cfg.types ? v.picklist(cfg.types) : v.string()),
+        type: cfg.types && cfg.types.length ? v.optional(v.picklist(cfg.types)) : v.never(),
         flags: v.optional(v.array(cfg.flags ? v.picklist(cfg.flags) : v.string())),
         duration: v.optional(v.number()),
         id: v.string(),
@@ -224,7 +225,10 @@ const createAlerterStore = (cfg = {}) => {
         }, showAt - Date.now());
     };
     const _addAlert = (payload, level) => {
-        const notification = buildNotification(payload, level);
+        const _payload = typeof payload === 'string' || Array.isArray(payload)
+            ? { message: payload }
+            : payload;
+        const notification = buildNotification(_payload, level);
         if (!notification.showAt) {
             // Notification starts active. Clone the array.
             alerts.active = [...alerts.active, addMethodsToAlertInfo(notification)];

package/esm/alertsStore/index.d.ts

@@ -13,14 +13,6 @@ declare const messageSchema: v.UnionSchema<[v.StringSchema<undefined>, v.ArraySc
     readonly text: v.StringSchema<undefined>;
 }, undefined>], undefined>, undefined>], undefined>;
 export type AlertMessage = v.InferOutput<typeof messageSchema>;
-type _AlertNotification<Level, Type, Flag> = {
-    level: Level;
-    message: AlertMessage;
-    type?: Type;
-    flags?: Array<Flag>;
-    duration?: number;
-    id: string;
-};
 declare const defaultAlertLevels: readonly ["info", "warning", "success", "error"];
 declare const defaultDurations: {
     BLINK: number;
@@ -36,7 +28,7 @@ declare const defaultDurations: {
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#type-alerterconfig
  */
-export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Duration extends string = keyof typeof defaultDurations, Durations extends Record<Duration, number> = Record<Duration, number>> = {
+export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Title extends boolean = false, Duration extends string = keyof typeof defaultDurations, Durations extends Record<Duration, number> = Record<Duration, number>> = {
     /**
      * Identifier for the alerts store, used to create the key to persist alerts
      * in `sessionStorage` (or other provided storage).
@@ -60,7 +52,7 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
      *
      * This can also be used for more basic styling or categorization purposes.
      *
-     * Default: no restrictions, any string value is allowed.
+     * Default: `[ ]`  (No types and the `type` property not allowed).
      */
     types?: Array<Type>;
     /**
@@ -97,6 +89,12 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
      * is `0` (indefinite)
      */
     defaultDuration?: Durations extends Record<infer D, number> ? D : never;
+    /**
+     * Whether to allow an optional `title` property on alerts.
+     *
+     * Default: `false`.
+     */
+    title?: Title;
     /**
      * Optional custom storage object to use instead of `sessionStorage` (the
      * default) for persisting alerts across page reloads, etc.
@@ -112,7 +110,7 @@ export type AlerterConfig<Level extends string = (typeof defaultAlertLevels)[num
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
  */
-export declare const createAlerterStore: <Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Duration extends string = keyof typeof defaultDurations>(cfg?: AlerterConfig<Level, Type, Flag, Duration>) => {
+export declare const createAlerterStore: <Level extends string = (typeof defaultAlertLevels)[number], Type extends string = string, Flag extends string = string, Title extends boolean = false, Duration extends string = keyof typeof defaultDurations>(cfg?: AlerterConfig<Level, Type, Flag, Title, Duration>) => {
     /**
      * Singleton object with methods for showing alerts of different levels.
      * Pass a payload object to the method of the level you want to dispatch,
@@ -123,7 +121,7 @@ export declare const createAlerterStore: <Level extends string = (typeof default
      *
      * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
      */
-    alerter: Record<Level, (payload: {
+    alerter: Record<Level, (payload: AlertMessage | ({
         /**
          * A simple string containing the alert message.
          *
@@ -135,13 +133,6 @@ export declare const createAlerterStore: <Level extends string = (typeof default
          * them.)
          */
         message: AlertMessage;
-        /**
-         * Allows distinguishing between different "types" of alerts, for example,
-         * to dispatch both "toasts" vs. "static alert banners" via the same store.
-         *
-         * May also be used for more basic styling or categorization purposes.
-         */
-        type?: Type;
         /**
          * Flag values can be changed during the lifetime of
          * an alert using the `setFlags` function on each `AlertInfo` object.
@@ -159,7 +150,20 @@ export declare const createAlerterStore: <Level extends string = (typeof default
          */
         duration?: Duration;
         delay?: number;
-    }) => void>;
+    } & (Title extends true ? {
+        /**
+         * Optional title to accompany the alert message.
+         */
+        title?: string;
+    } : unknown) & (string extends Type ? unknown : {
+        /**
+         * Allows distinguishing between different "types" of alerts, for example,
+         * to dispatch both "toasts" vs. "static alert banners" via the same store.
+         *
+         * May also be used for more basic styling or categorization purposes.
+         */
+        type?: Type;
+    }))) => void>;
     /**
      * Subscribes to alert events. The provided callback will be called whenever a
      * alert is added or cleared.
@@ -172,7 +176,17 @@ export declare const createAlerterStore: <Level extends string = (typeof default
      *
      * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#createalerterstore
      */
-    subscribe: (callback: (notifications: Array<_AlertNotification<Level, Type, Flag> & {
+    subscribe: (callback: (notifications: Array<{
+        level: Level;
+        message: AlertMessage;
+        flags?: Flag[] | undefined;
+        duration?: number;
+        id: string;
+    } & (Title extends true ? {
+        title?: string;
+    } : unknown) & (string extends Type ? unknown : {
+        type?: Type | undefined;
+    }) & {
         /** Dispatcher function that dismisses/hides/removes the callback */
         dismiss: () => void;
         /**

package/esm/alertsStore/index.js

@@ -59,8 +59,9 @@ export const createAlerterStore = (cfg = {}) => {
         : defaultDefaultDuration;
     const _notificationSchema = v.object({
         level: v.picklist(alertLevels),
+        title: cfg.title ? v.optional(v.string()) : v.never(),
         message: messageSchema,
-        type: v.optional(cfg.types ? v.picklist(cfg.types) : v.string()),
+        type: cfg.types && cfg.types.length ? v.optional(v.picklist(cfg.types)) : v.never(),
         flags: v.optional(v.array(cfg.flags ? v.picklist(cfg.flags) : v.string())),
         duration: v.optional(v.number()),
         id: v.string(),
@@ -188,7 +189,10 @@ export const createAlerterStore = (cfg = {}) => {
         }, showAt - Date.now());
     };
     const _addAlert = (payload, level) => {
-        const notification = buildNotification(payload, level);
+        const _payload = typeof payload === 'string' || Array.isArray(payload)
+            ? { message: payload }
+            : payload;
+        const notification = buildNotification(_payload, level);
         if (!notification.showAt) {
             // Notification starts active. Clone the array.
             alerts.active = [...alerts.active, addMethodsToAlertInfo(notification)];

package/package.json

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