@luzzle/web.tools 0.0.69

package/dist/src/lib/config/config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/lib/config/config.test.js

@@ -0,0 +1,71 @@
+import { describe, expect, test } from 'vitest';
+import { loadConfig, getConfigValue, setConfigValue } from './config.js';
+describe('lib/config/config', () => {
+    test('should validate default config against schema', async () => {
+        try {
+            const config = loadConfig();
+            expect(config).toBeDefined();
+        }
+        catch (e) {
+            if (e) {
+                expect(e).toBeUndefined();
+            }
+        }
+    });
+    test('should load a user config', () => {
+        const config = loadConfig(`${import.meta.dirname}/user.config.yaml`);
+        expect(config).toBeDefined();
+    });
+    test('should load a user config', () => {
+        const config = loadConfig(`${import.meta.dirname}/not.user.config.yaml`);
+        expect(config).toBeDefined();
+    });
+    test('should throw an error if config validation fails with user config', () => {
+        expect(() => loadConfig(`${import.meta.dirname}/user-error.config.yaml`)).toThrow('Configuration validation failed');
+    });
+    describe('getConfigValue', () => {
+        test('should return the correct value for a given path', () => {
+            const config = {
+                a: {
+                    b: {
+                        c: 'value'
+                    }
+                }
+            };
+            const value = getConfigValue(config, 'a.b.c');
+            expect(value).toBe('value');
+        });
+        test('should return undefined for a non-existent path', () => {
+            const config = {
+                a: {
+                    b: {
+                        c: 'value'
+                    }
+                }
+            };
+            const value = getConfigValue(config, 'a.b.d');
+            expect(value).toBeUndefined();
+        });
+    });
+    describe('setConfigValue', () => {
+        test('should correctly set a value at a given path', () => {
+            const config = {
+                a: {
+                    b: {
+                        c: 'value'
+                    }
+                }
+            };
+            setConfigValue(config, 'a.b.c', 'new-value');
+            expect(config.a.b.c).toBe('new-value');
+        });
+        test('should create intermediate objects if they don\'t exist', () => {
+            const config = {
+                a: {}
+            };
+            setConfigValue(config, 'a.b.c', 'value');
+            expect(config.a.b.c).toBe('value');
+        });
+    });
+});
+//# sourceMappingURL=config.test.js.map

package/dist/src/lib/config/config.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../../../src/lib/config/config.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAU,MAAM,aAAa,CAAA;AAUhF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAClC,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAChE,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,UAAU,EAAE,CAAA;YAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;QAC7B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,EAAE,CAAC;gBACP,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAA;YAC1B,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAA;QACpE,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,uBAAuB,CAAC,CAAA;QACxE,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC9E,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAChF,iCAAiC,CACjC,CAAA;IACF,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC/B,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC7D,MAAM,MAAM,GAAG;gBACd,CAAC,EAAE;oBACF,CAAC,EAAE;wBACF,CAAC,EAAE,OAAO;qBACV;iBACD;aACwB,CAAA;YAC1B,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAC7C,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC5D,MAAM,MAAM,GAAG;gBACd,CAAC,EAAE;oBACF,CAAC,EAAE;wBACF,CAAC,EAAE,OAAO;qBACV;iBACD;aACwB,CAAA;YAC1B,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAC7C,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAA;QAC9B,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC/B,IAAI,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACzD,MAAM,MAAM,GAAG;gBACd,CAAC,EAAE;oBACF,CAAC,EAAE;wBACF,CAAC,EAAE,OAAO;qBACV;iBACD;aACwB,CAAA;YAC1B,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;YAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACpE,MAAM,MAAM,GAAG;gBACd,CAAC,EAAE,EAAE;aACoB,CAAA;YAC1B,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;YACxC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/src/lib/config/config.test.ts

@@ -0,0 +1,88 @@
+import { describe, expect, test } from 'vitest'
+import { loadConfig, getConfigValue, setConfigValue, Config } from './config.js'
+
+interface TestConfig extends Config {
+  a: {
+    b: {
+      c: string
+    }
+  }
+}
+
+describe('lib/config/config', () => {
+	test('should validate default config against schema', async () => {
+		try {
+			const config = loadConfig()
+			expect(config).toBeDefined()
+		} catch (e) {
+			if (e) {
+				expect(e).toBeUndefined()
+			}
+		}
+	})
+
+	test('should load a user config', () => {
+		const config = loadConfig(`${import.meta.dirname}/user.config.yaml`)
+		expect(config).toBeDefined()
+	})
+
+	test('should load a user config', () => {
+		const config = loadConfig(`${import.meta.dirname}/not.user.config.yaml`)
+		expect(config).toBeDefined()
+	})
+
+	test('should throw an error if config validation fails with user config', () => {
+		expect(() => loadConfig(`${import.meta.dirname}/user-error.config.yaml`)).toThrow(
+			'Configuration validation failed'
+		)
+	})
+
+	describe('getConfigValue', () => {
+		test('should return the correct value for a given path', () => {
+			const config = {
+				a: {
+					b: {
+						c: 'value'
+					}
+				}
+			} as unknown as TestConfig
+			const value = getConfigValue(config, 'a.b.c')
+			expect(value).toBe('value')
+		})
+
+		test('should return undefined for a non-existent path', () => {
+			const config = {
+				a: {
+					b: {
+						c: 'value'
+					}
+				}
+			} as unknown as TestConfig
+			const value = getConfigValue(config, 'a.b.d')
+			expect(value).toBeUndefined()
+		})
+	})
+
+	describe('setConfigValue', () => {
+		test('should correctly set a value at a given path', () => {
+			const config = {
+				a: {
+					b: {
+						c: 'value'
+					}
+				}
+			} as unknown as TestConfig
+			setConfigValue(config, 'a.b.c', 'new-value')
+			expect(config.a.b.c).toBe('new-value')
+		})
+
+		test('should create intermediate objects if they don\'t exist', () => {
+			const config = {
+				a: {}
+			} as unknown as TestConfig
+			setConfigValue(config, 'a.b.c', 'value')
+			expect(config.a.b.c).toBe('value')
+		})
+	})
+})
+

package/dist/src/lib/config/config.ts

@@ -0,0 +1,74 @@
+import { readFileSync, existsSync } from 'fs'
+import { parse as yamlParse } from 'yaml'
+import { Ajv } from 'ajv'
+import { deepMerge } from '../deep-merge.js'
+import { type Schema as Config } from './schema.js'
+import defaults from './defaults.json' with { type: 'json' }
+import schemaJson from './schema.json' with { type: 'json' }
+
+export type ConfigPublic = {
+	url: Pick<Config['url'], 'app' | 'luzzle_assets' | 'app_assets'>
+	text: Config['text']
+}
+
+function loadConfig(userConfigPath?: string): Config {
+	const schema = schemaJson
+	const config = defaults as Config
+	const ajv = new Ajv()
+	const validate = ajv.compile(schema)
+
+	config.paths.config = userConfigPath
+
+	if (userConfigPath) {
+		if (existsSync(userConfigPath)) {
+			const userConfig = yamlParse(readFileSync(userConfigPath, 'utf8')) as Partial<Config>
+			const mergedConfig = deepMerge(config, userConfig) as Config
+
+			if (!validate(mergedConfig)) {
+				throw new Error(`Configuration validation failed: ${ajv.errorsText(validate.errors)}`)
+			}
+
+			return mergedConfig
+		} else {
+			/* v8 ignore start */
+			console.warn(`User config file not found at: ${userConfigPath}`)
+			/* v8 ignore stop */
+		}
+	}
+
+	/* v8 ignore start */
+	if (!validate(config)) {
+		throw new Error(`Configuration validation failed: ${ajv.errorsText(validate.errors)}`)
+	}
+	/* v8 ignore stop */
+
+	return config
+}
+
+function getConfigValue(obj: Config, path: string): unknown {
+	return path.split('.').reduce(
+		(acc, key) => {
+			if (acc && typeof acc === 'object' && key in acc) {
+				return acc[key] as Record<string, unknown>
+			}
+			return undefined
+		},
+		obj as unknown as undefined | Record<string, unknown>
+	)
+}
+
+function setConfigValue(obj: Config, path: string, value: unknown): void {
+	const keys = path.split('.')
+	const lastKey = keys.pop()!
+	let current: Record<string, unknown> = obj as unknown as Record<string, unknown>
+
+	for (const key of keys) {
+		if (typeof current[key] !== 'object' || current[key] === null) {
+			current[key] = {}
+		}
+		current = current[key] as Record<string, unknown>
+	}
+	current[lastKey] = value
+}
+
+export { loadConfig, getConfigValue, setConfigValue, type Config }

package/dist/src/lib/config/defaults.json

@@ -0,0 +1,145 @@
+{
+  "url": {
+    "app": "",
+    "app_assets": "",
+    "luzzle_assets": "",
+    "editor": "http://editor.localhost"
+  },
+  "text": {
+    "title": "Luzzle Explorer",
+    "description": "A Luzzle Explorer instance"
+  },
+  "paths": {
+    "database": "./data/luzzle.sqlite"
+  },
+  "pieces": [],
+  "theme": {
+    "globals": {
+      "shadow-raised": "0px 3px 1px -2px rgba(251 241 199 / 20%), 0px 2px 2px 0px rgba(251 241 199 / 14%), 0px 1px 5px 0px rgba(0 0 0 / 12%)",
+      "font-sans-name": "\"Noto Sans\"",
+      "font-mono-name": "\"monaco, monospace\"",
+      "font-sans-url": "\"/fonts/noto-sans.woff2\"",
+      "font-sans-weight": "300 600",
+      "font-size-xxs": "0.7rem",
+      "font-size-xs": "0.825rem",
+      "font-size-small": "1rem",
+      "font-size-normal": "1.25rem",
+      "font-size-medium": "1.5rem",
+      "font-size-large": "1.75rem",
+      "font-size-xl": "2rem",
+      "font-size-xxl": "2.25rem",
+      "font-size-mobile-responsive-factor": 0.8,
+      "font-size-root": 22,
+      "font-weight-light": 300,
+      "font-weight-normal": 400,
+      "font-weight-medium": 500,
+      "font-weight-semibold": 550,
+      "font-weight-bold": 600,
+      "radius-none": "0",
+      "radius-small": "0.25rem",
+      "radius-medium": "0.375rem",
+      "radius-large": "0.5rem",
+      "radius-xl": "0.75rem",
+      "radius-x2l": "1rem",
+      "radius-x3l": "1.5rem",
+      "radius-x4l": "2.5rem",
+      "radius-full": "9999px",
+      "breakpoint-phone": 640,
+      "breakpoint-tablet": 768,
+      "breakpoint-laptop": 1024,
+      "breakpoint-desktop": 1280,
+      "space-1": "0.25rem",
+      "space-2": "0.5rem",
+      "space-3": "0.75rem",
+      "space-4": "1rem",
+      "space-5": "1.25rem",
+      "space-6": "1.5rem",
+      "space-7": "1.75rem",
+      "space-8": "2rem",
+      "space-9": "2.25rem",
+      "space-10": "2.5rem",
+      "space-0-5": "0.125rem",
+      "space-1-5": "0.375rem",
+      "space-2-5": "0.625rem",
+      "space-3-5": "0.875rem"
+    },
+    "dark": {
+      "color-primary": "#3b82f6",
+      "color-on-primary": "#ffffff",
+      "color-primary-container": "#0d6efd",
+      "color-on-primary-container": "#cfe2ff",
+      "color-secondary": "#adb5bd",
+      "color-on-secondary": "#212529",
+      "color-secondary-container": "#495057",
+      "color-on-secondary-container": "#d3d3d4",
+      "color-tertiary": "#adb5bd",
+      "color-on-tertiary": "#212529",
+      "color-tertiary-container": "#495057",
+      "color-on-tertiary-container": "#d3d3d4",
+      "color-error": "#f87171",
+      "color-on-error": "#4f0b0b",
+      "color-error-container": "#dc3545",
+      "color-on-error-container": "#f8d7da",
+      "color-surface": "#121212",
+      "color-surface-dim": "#1f1f1f",
+      "color-surface-bright": "#333333",
+      "color-surface-inverse": "#e9ecef",
+      "color-on-surface": "#e9ecef",
+      "color-on-surface-variant": "#adb5bd",
+      "color-on-surface-inverse": "#121212",
+      "color-surface-container-lowest": "#1f1f1f",
+      "color-surface-container-low": "#333333",
+      "color-surface-container": "#4f4f4f",
+      "color-surface-container-high": "#666666",
+      "color-surface-container-highest": "#7f7f7f",
+      "color-shadow": "hsla(0, 0%, 0%, 0.5)",
+      "color-outline": "#6c757d",
+      "color-outline-variant": "#495057"
+    },
+    "light": {
+      "color-primary": "#0d6efd",
+      "color-on-primary": "#ffffff",
+      "color-primary-container": "#cfe2ff",
+      "color-on-primary-container": "#084298",
+      "color-secondary": "#6c757d",
+      "color-on-secondary": "#ffffff",
+      "color-secondary-container": "#d3d3d4",
+      "color-on-secondary-container": "#41464b",
+      "color-tertiary": "#6c757d",
+      "color-on-tertiary": "#ffffff",
+      "color-tertiary-container": "#d3d3d4",
+      "color-on-tertiary-container": "#41464b",
+      "color-error": "#dc3545",
+      "color-on-error": "#ffffff",
+      "color-error-container": "#f8d7da",
+      "color-on-error-container": "#842029",
+      "color-surface": "#f8f9fa",
+      "color-surface-dim": "#e9ecef",
+      "color-surface-bright": "#ffffff",
+      "color-surface-inverse": "#212529",
+      "color-on-surface": "#212529",
+      "color-on-surface-variant": "#495057",
+      "color-on-surface-inverse": "#f8f9fa",
+      "color-surface-container-lowest": "#ffffff",
+      "color-surface-container-low": "#e9ecef",
+      "color-surface-container": "#dee2e6",
+      "color-surface-container-high": "#ced4da",
+      "color-surface-container-highest": "#adb5bd",
+      "color-shadow": "hsla(0, 0%, 0%, 0.15)",
+      "color-outline": "#6c757d",
+      "color-outline-variant": "#ced4da"
+    },
+    "markdown": {
+      "code": {
+        "light": "github-light",
+        "dark": "github-dark"
+      },
+      "sidenote": {
+        "sidenote-callout-before-content": "\"[ \"",
+        "sidenote-callout-after-content": "\" ]\"",
+        "sidenote-citation-before-content": "\"\"",
+        "sidenote-citation-after-content": "\":\""
+      }
+    }
+  }
+}

package/dist/src/lib/config/defaults.yaml

@@ -0,0 +1,151 @@
+# Default configuration for Luzzle Web Explorer.
+# These values can be overridden by a user-provided config.yaml
+# or by environment variables.
+
+# Defines the key URLs required for the application to function correctly.
+url:
+  # The primary, public-facing URL of this Luzzle Explorer instance.
+  app: ''
+
+  # The base URL for _app assets hosted on a separate CDN or file server.
+  app_assets: ''
+
+  # The base URL for assets hosted on a separate CDN or file server.
+  luzzle_assets: ''
+
+  # The URL for the Luzzle Editor instance, used for edit links.
+  editor: 'http://editor.localhost'
+
+# general app text strings
+text:
+  title: 'Luzzle Explorer'
+  description: 'A Luzzle Explorer instance'
+
+paths:
+  # The connection URL for the database.
+  database: './data/luzzle.sqlite'
+
+pieces: []
+
+theme:
+  globals:
+    shadow-raised: '0px 3px 1px -2px rgba(251 241 199 / 20%), 0px 2px 2px 0px rgba(251 241 199 / 14%), 0px 1px 5px 0px rgba(0 0 0 / 12%)'
+    font-sans-name: '"Noto Sans"'
+    font-mono-name: '"monaco, monospace"'
+    font-sans-url: '"/fonts/noto-sans.woff2"'
+    font-sans-weight: '300 600'
+    font-size-xxs: '0.7rem'
+    font-size-xs: '0.825rem'
+    font-size-small: '1rem'
+    font-size-normal: '1.25rem'
+    font-size-medium: '1.5rem'
+    font-size-large: '1.75rem'
+    font-size-xl: '2rem'
+    font-size-xxl: '2.25rem'
+    font-size-mobile-responsive-factor: 0.8
+    font-size-root: 22
+    font-weight-light: 300
+    font-weight-normal: 400
+    font-weight-medium: 500
+    font-weight-semibold: 550
+    font-weight-bold: 600
+    radius-none: '0'
+    radius-small: '0.25rem'
+    radius-medium: '0.375rem'
+    radius-large: '0.5rem'
+    radius-xl: '0.75rem'
+    radius-x2l: '1rem'
+    radius-x3l: '1.5rem'
+    radius-x4l: '2.5rem'
+    radius-full: '9999px'
+    breakpoint-phone: 640
+    breakpoint-tablet: 768
+    breakpoint-laptop: 1024
+    breakpoint-desktop: 1280
+    space-1: '0.25rem'
+    space-2: '0.5rem'
+    space-3: '0.75rem'
+    space-4: '1rem'
+    space-5: '1.25rem'
+    space-6: '1.5rem'
+    space-7: '1.75rem'
+    space-8: '2rem'
+    space-9: '2.25rem'
+    space-10: '2.5rem'
+    space-0-5: '0.125rem'
+    space-1-5: '0.375rem'
+    space-2-5: '0.625rem'
+    space-3-5: '0.875rem'
+  dark:
+    color-primary: '#3b82f6'
+    color-on-primary: '#ffffff'
+    color-primary-container: '#0d6efd'
+    color-on-primary-container: '#cfe2ff'
+    color-secondary: '#adb5bd'
+    color-on-secondary: '#212529'
+    color-secondary-container: '#495057'
+    color-on-secondary-container: '#d3d3d4'
+    color-tertiary: '#adb5bd'
+    color-on-tertiary: '#212529'
+    color-tertiary-container: '#495057'
+    color-on-tertiary-container: '#d3d3d4'
+    color-error: '#f87171'
+    color-on-error: '#4f0b0b'
+    color-error-container: '#dc3545'
+    color-on-error-container: '#f8d7da'
+    color-surface: '#121212'
+    color-surface-dim: '#1f1f1f'
+    color-surface-bright: '#333333'
+    color-surface-inverse: '#e9ecef'
+    color-on-surface: '#e9ecef'
+    color-on-surface-variant: '#adb5bd'
+    color-on-surface-inverse: '#121212'
+    color-surface-container-lowest: '#1f1f1f'
+    color-surface-container-low: '#333333'
+    color-surface-container: '#4f4f4f'
+    color-surface-container-high: '#666666'
+    color-surface-container-highest: '#7f7f7f'
+    color-shadow: 'hsla(0, 0%, 0%, 0.5)'
+    color-outline: '#6c757d'
+    color-outline-variant: '#495057'
+  light:
+    color-primary: '#0d6efd'
+    color-on-primary: '#ffffff'
+    color-primary-container: '#cfe2ff'
+    color-on-primary-container: '#084298'
+    color-secondary: '#6c757d'
+    color-on-secondary: '#ffffff'
+    color-secondary-container: '#d3d3d4'
+    color-on-secondary-container: '#41464b'
+    color-tertiary: '#6c757d'
+    color-on-tertiary: '#ffffff'
+    color-tertiary-container: '#d3d3d4'
+    color-on-tertiary-container: '#41464b'
+    color-error: '#dc3545'
+    color-on-error: '#ffffff'
+    color-error-container: '#f8d7da'
+    color-on-error-container: '#842029'
+    color-surface: '#f8f9fa'
+    color-surface-dim: '#e9ecef'
+    color-surface-bright: '#ffffff'
+    color-surface-inverse: '#212529'
+    color-on-surface: '#212529'
+    color-on-surface-variant: '#495057'
+    color-on-surface-inverse: '#f8f9fa'
+    color-surface-container-lowest: '#ffffff'
+    color-surface-container-low: '#e9ecef'
+    color-surface-container: '#dee2e6'
+    color-surface-container-high: '#ced4da'
+    color-surface-container-highest: '#adb5bd'
+    color-shadow: 'hsla(0, 0%, 0%, 0.15)'
+    color-outline: '#6c757d'
+    color-outline-variant: '#ced4da'
+  markdown:
+    code:
+      light: 'github-light'
+      dark: 'github-dark'
+    sidenote:
+      sidenote-callout-before-content: '"[ "'
+      sidenote-callout-after-content: '" ]"'
+      sidenote-citation-before-content: '""'
+      sidenote-citation-after-content: '":"'