@meith/settings 0.29.1 → 0.30.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meith/settings",
-  "version": "0.29.1",
+  "version": "0.30.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "zod": "^4.4.3",
-    "@meith/core": "0.29.1",
-    "@meith/i18n": "0.29.1"
+    "@meith/core": "0.30.1",
+    "@meith/i18n": "0.30.1"
   }
 }

package/src/branding.ts

@@ -4,6 +4,8 @@ export const LOGO_SCHEMES: readonly LogoScheme[] = ['light', 'dark']
 
 const LOGO_KEY = /^board\/logo-(light|dark)-[a-f0-9-]{36}\.(png|jpg|webp|svg)$/
 
+const FAVICON_KEY = /^board\/favicon-[a-f0-9-]{36}\.(png|jpg|webp|svg)$/
+
 export function isLogoScheme(value: unknown): value is LogoScheme {
   return value === 'light' || value === 'dark'
 }
@@ -12,10 +14,22 @@ export function isLogoKey(value: string): boolean {
   return LOGO_KEY.test(value)
 }
 
+export function isFaviconKey(value: string): boolean {
+  return FAVICON_KEY.test(value)
+}
+
 export function logoFormat(key: string): string | null {
   return LOGO_KEY.exec(key)?.[2] ?? null
 }
 
+export function faviconFormat(key: string): string | null {
+  return FAVICON_KEY.exec(key)?.[1] ?? null
+}
+
+export function faviconPath(key: string): string {
+  return `/brand/favicon?v=${key.slice(-16, -4)}`
+}
+
 export function logoPath(scheme: LogoScheme, key: string): string {
   return `/logo/${scheme}?v=${key.slice(-16, -4)}`
 }

package/src/definitions.ts

@@ -90,6 +90,21 @@ export const SETTING_DEFINITIONS = [
     invalidates: ['settings', 'layout'],
     ui: { multiline: true },
   }),
+  define({
+    key: 'board.install_banner',
+    group: 'board',
+    label: 'Offer to install the board',
+    description:
+      'Pins a dismissable bar to the bottom of small screens inviting the reader ' +
+      'to add this board to their home screen, with an Install button that opens ' +
+      'the browser prompt where one exists and brief directions where none does. ' +
+      'It never shows inside the installed app, and dismissing it keeps it away ' +
+      'on that device for a year. Off by default: turn it on while you want ' +
+      'installs encouraged, and off again once the point is made.',
+    schema: z.boolean(),
+    default: false,
+    invalidates: ['settings', 'layout'],
+  }),
   define({
     key: 'board.offline',
     group: 'board',
@@ -302,6 +317,19 @@ export const SETTING_DEFINITIONS = [
     invalidates: ['settings', 'layout'],
     ui: { managed: true },
   }),
+  define({
+    key: 'board.favicon',
+    group: 'board',
+    label: 'Favicon',
+    description:
+      'The icon browser tabs, bookmarks and an installed shortcut show for this board. ' +
+      'Uploaded, not typed. Left empty, an icon is generated from the board name and its ' +
+      'theme colours.',
+    schema: z.string().max(300),
+    default: '',
+    invalidates: ['settings', 'layout'],
+    ui: { managed: true },
+  }),
   define({
     key: 'board.logo_alt',
     group: 'board',

package/src/index.ts

@@ -7,6 +7,9 @@ export {
   resolveBoardUrl,
 } from './board-url'
 export {
+  faviconFormat,
+  faviconPath,
+  isFaviconKey,
   isLogoKey,
   isLogoScheme,
   LOGO_SCHEMES,