@aerogel/core 0.0.0-next.7f6ed5a1f91688a86bf5ede2adc465e4fd6cfdea → 0.0.0-next.8323c60b905020dcb3bd9d4b0bc8d9b6529e1082

package/src/directives/index.ts

@@ -1,13 +1,36 @@
 import type { Directive } from 'vue';
 
-import { defineBootstrapHook } from '@/bootstrap/hooks';
+import { definePlugin } from '@aerogel/core/plugins';
 
-import initialFocus from './initial-focus';
+import measure from './measure';
 
-const directives: Record<string, Directive> = {
-    'initial-focus': initialFocus,
+const builtInDirectives: Record<string, Directive> = {
+    measure: measure,
 };
 
-export default defineBootstrapHook(async (app) => {
-    Object.entries(directives).forEach(([name, directive]) => app.directive(name, directive));
+export * from './measure';
+
+export default definePlugin({
+    install(app, options) {
+        const directives = {
+            ...builtInDirectives,
+            ...options.directives,
+        };
+
+        for (const [name, directive] of Object.entries(directives)) {
+            app.directive(name, directive);
+        }
+    },
 });
+
+declare module '@aerogel/core/bootstrap/options' {
+    export interface AerogelOptions {
+        directives?: Record<string, Directive>;
+    }
+}
+
+declare module 'vue' {
+    interface ComponentCustomDirectives {
+        measure: Directive<string, string>;
+    }
+}

package/src/directives/measure.ts

@@ -0,0 +1,46 @@
+import { defineDirective } from '@aerogel/core/utils/vue';
+import { tap } from '@noeldemartin/utils';
+
+const resizeObservers: WeakMap<HTMLElement, ResizeObserver> = new WeakMap();
+
+export type MeasureDirectiveValue =
+    | MeasureDirectiveListener
+    | {
+          css?: boolean;
+          watch?: boolean;
+      };
+
+export type MeasureDirectiveModifiers = 'css' | 'watch';
+
+export interface ElementSize {
+    width: number;
+    height: number;
+}
+
+export type MeasureDirectiveListener = (size: ElementSize) => unknown;
+
+export default defineDirective<MeasureDirectiveValue, MeasureDirectiveModifiers>({
+    mounted(element: HTMLElement, { value, modifiers }) {
+        const listener = typeof value === 'function' ? (value as MeasureDirectiveListener) : null;
+        const update = () => {
+            const sizes = element.getBoundingClientRect();
+
+            if (modifiers.css) {
+                element.style.setProperty('--width', `${sizes.width}px`);
+                element.style.setProperty('--height', `${sizes.height}px`);
+            }
+
+            listener?.({ width: sizes.width, height: sizes.height });
+        };
+
+        if (modifiers.watch) {
+            resizeObservers.set(element, tap(new ResizeObserver(update)).observe(element));
+        }
+
+        update();
+    },
+    unmounted(element) {
+        resizeObservers.get(element)?.unobserve(element);
+        resizeObservers.delete(element);
+    },
+});

package/src/errors/Errors.state.ts

@@ -0,0 +1,31 @@
+import type { JSError } from '@noeldemartin/utils';
+
+import { defineServiceState } from '@aerogel/core/services';
+
+export type ErrorSource = string | Error | JSError | unknown;
+
+export interface ErrorReport {
+    title: string;
+    description?: string;
+    details?: string;
+    error?: Error | JSError | unknown;
+}
+
+export interface ErrorReportLog {
+    report: ErrorReport;
+    seen: boolean;
+    date: Date;
+}
+
+export default defineServiceState({
+    name: 'errors',
+    initialState: {
+        logs: [] as ErrorReportLog[],
+        startupErrors: [] as ErrorReport[],
+    },
+    computed: {
+        hasErrors: ({ logs }) => logs.length > 0,
+        hasNewErrors: ({ logs }) => logs.some((error) => !error.seen),
+        hasStartupErrors: ({ startupErrors }) => startupErrors.length > 0,
+    },
+});

package/src/errors/Errors.ts

@@ -0,0 +1,200 @@
+import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+
+import App from '@aerogel/core/services/App';
+import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
+import UI from '@aerogel/core/ui/UI';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
+import { Events } from '@aerogel/core/services';
+
+import Service from './Errors.state';
+import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+
+export class ErrorsService extends Service {
+
+    public forceReporting: boolean = false;
+    private enabled: boolean = true;
+
+    public enable(): void {
+        this.enabled = true;
+    }
+
+    public disable(): void {
+        this.enabled = false;
+    }
+
+    public async inspect(error: ErrorSource | ErrorReport, reports?: ErrorReport[]): Promise<void>;
+    public async inspect(reports: ErrorReport[]): Promise<void>;
+    public async inspect(errorOrReports: ErrorSource | ErrorReport[], _reports?: ErrorReport[]): Promise<void> {
+        if (Array.isArray(errorOrReports) && errorOrReports.length === 0) {
+            UI.alert(translateWithDefault('errors.inspectEmpty', 'Nothing to inspect!'));
+
+            return;
+        }
+
+        const report = Array.isArray(errorOrReports)
+            ? (errorOrReports[0] as ErrorReport)
+            : this.isErrorReport(errorOrReports)
+                ? errorOrReports
+                : await this.createErrorReport(errorOrReports);
+        const reports = Array.isArray(errorOrReports) ? (errorOrReports as ErrorReport[]) : (_reports ?? [report]);
+
+        UI.modal(UI.requireComponent('error-report-modal'), { report, reports });
+    }
+
+    public async report(error: ErrorSource, message?: string): Promise<void> {
+        await Events.emit('error', { error, message });
+
+        if (isTesting('unit')) {
+            throw error;
+        }
+
+        if (isDevelopment()) {
+            this.logError(error);
+        }
+
+        if (!this.enabled) {
+            throw error;
+        }
+
+        if (!App.isMounted()) {
+            const startupError = await this.createStartupErrorReport(error);
+
+            if (startupError) {
+                this.setState({ startupErrors: this.startupErrors.concat(startupError) });
+            }
+
+            return;
+        }
+
+        const report = await this.createErrorReport(error);
+        const log: ErrorReportLog = {
+            report,
+            seen: false,
+            date: new Date(),
+        };
+
+        UI.toast(
+            message ??
+                translateWithDefault('errors.notice', 'Something went wrong, but it\'s not your fault. Try again!'),
+            {
+                variant: 'danger',
+                actions: [
+                    {
+                        label: translateWithDefault('errors.viewDetails', 'View details'),
+                        dismiss: true,
+                        click: () => UI.modal(UI.requireComponent('error-report-modal'), { report, reports: [report] }),
+                    },
+                ],
+            },
+        );
+
+        this.setState({ logs: [log].concat(this.logs) });
+    }
+
+    public reportDevelopmentError(error: ErrorSource, message?: string): void {
+        if (!isDevelopment()) {
+            return;
+        }
+
+        if (message) {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+        }
+
+        this.logError(error);
+    }
+
+    public see(report: ErrorReport): void {
+        this.setState({
+            logs: this.logs.map((log) => {
+                if (log.report !== report) {
+                    return log;
+                }
+
+                return {
+                    ...log,
+                    seen: true,
+                };
+            }),
+        });
+    }
+
+    public seeAll(): void {
+        this.setState({
+            logs: this.logs.map((log) => ({
+                ...log,
+                seen: true,
+            })),
+        });
+    }
+
+    private logError(error: unknown): void {
+        // eslint-disable-next-line no-console
+        console.error(error);
+
+        if (isObject(error) && error.cause) {
+            this.logError(error.cause);
+        }
+    }
+
+    private isErrorReport(error: unknown): error is ErrorReport {
+        return isObject(error) && 'title' in error;
+    }
+
+    private async createErrorReport(error: ErrorSource): Promise<ErrorReport> {
+        if (typeof error === 'string') {
+            return { title: error };
+        }
+
+        if (error instanceof Error || error instanceof JSError) {
+            return this.createErrorReportFromError(error);
+        }
+
+        if (isObject(error)) {
+            return objectWithoutEmpty({
+                title: toString(
+                    error['name'] ?? error['title'] ?? translateWithDefault('errors.unknown', 'Unknown Error'),
+                ),
+                description: toString(
+                    error['message'] ??
+                        error['description'] ??
+                        translateWithDefault('errors.unknownDescription', 'Unknown error object'),
+                ),
+                error,
+            });
+        }
+
+        return {
+            title: translateWithDefault('errors.unknown', 'Unknown Error'),
+            error,
+        };
+    }
+
+    private async createStartupErrorReport(error: ErrorSource): Promise<ErrorReport | null> {
+        if (error instanceof ServiceBootError) {
+            // Ignore second-order boot errors in order to have a cleaner startup crash screen.
+            return error.cause instanceof ServiceBootError ? null : this.createErrorReport(error.cause);
+        }
+
+        return this.createErrorReport(error);
+    }
+
+    private createErrorReportFromError(error: Error | JSError, defaults: Partial<ErrorReport> = {}): ErrorReport {
+        return {
+            title: error.name,
+            description: error.message,
+            details: error.stack,
+            error,
+            ...defaults,
+        };
+    }
+
+}
+
+export default facade(ErrorsService);
+
+declare module '@aerogel/core/services/Events' {
+    export interface EventsPayload {
+        error: { error: ErrorSource; message?: string };
+    }
+}

package/src/errors/JobCancelledError.ts

@@ -0,0 +1,3 @@
+import { JSError } from '@noeldemartin/utils';
+
+export default class JobCancelledError extends JSError {}

package/src/errors/index.ts

@@ -0,0 +1,53 @@
+import type { App as AppInstance } from 'vue';
+
+import App from '@aerogel/core/services/App';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
+
+import Errors from './Errors';
+import settings from './settings';
+import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+
+export * from './utils';
+export { Errors };
+export { default as JobCancelledError } from './JobCancelledError';
+export { default as ServiceBootError } from './ServiceBootError';
+export type { ErrorSource, ErrorReport, ErrorReportLog };
+
+const services = { $errors: Errors };
+const frameworkHandler: ErrorHandler = (error) => {
+    Errors.report(error);
+
+    return true;
+};
+
+function setUpErrorHandler(app: AppInstance, baseHandler: ErrorHandler = () => false): void {
+    const errorHandler: ErrorHandler = (error) => baseHandler(error) || frameworkHandler(error);
+
+    app.config.errorHandler = errorHandler;
+    globalThis.onerror = (event, _, __, ___, error) => errorHandler(error ?? event);
+    globalThis.onunhandledrejection = (event) => errorHandler(event.reason);
+}
+
+export type ErrorHandler = (error: ErrorSource) => boolean;
+export type ErrorsServices = typeof services;
+
+export default definePlugin({
+    async install(app, options) {
+        setUpErrorHandler(app, options.handleError);
+
+        settings.forEach((setting) => App.addSetting(setting));
+
+        await bootServices(app, services);
+    },
+});
+
+declare module '@aerogel/core/bootstrap/options' {
+    export interface AerogelOptions {
+        handleError?(error: ErrorSource): boolean;
+    }
+}
+
+declare module '@aerogel/core/services' {
+    export interface Services extends ErrorsServices {}
+}

package/src/errors/settings/Debug.vue

@@ -0,0 +1,32 @@
+<template>
+    <Setting
+        title-id="debug-setting"
+        :title="$td('settings.debug', 'Debugging')"
+        :description="$td('settings.debugDescription', 'Enable debugging with [Eruda](https://eruda.liriliri.io/).')"
+    >
+        <Switch v-model="enabled" aria-labelledby="debug-setting" />
+    </Setting>
+</template>
+
+<script setup lang="ts">
+import { ref, watchEffect } from 'vue';
+import type Eruda from 'eruda';
+
+import Setting from '@aerogel/core/components/ui/Setting.vue';
+import Switch from '@aerogel/core/components/ui/Switch.vue';
+
+let eruda: typeof Eruda | null = null;
+const enabled = ref(false);
+
+watchEffect(async () => {
+    if (!enabled.value) {
+        eruda?.destroy();
+
+        return;
+    }
+
+    eruda ??= (await import('eruda')).default;
+
+    eruda.init();
+});
+</script>

package/src/errors/settings/index.ts

@@ -0,0 +1,10 @@
+import { defineSettings } from '@aerogel/core/services';
+
+import Debug from './Debug.vue';
+
+export default defineSettings([
+    {
+        priority: 10,
+        component: Debug,
+    },
+]);

package/src/errors/utils.ts

@@ -0,0 +1,35 @@
+import { JSError, isObject, toString } from '@noeldemartin/utils';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
+import type { ErrorSource } from './Errors.state';
+
+const handlers: ErrorHandler[] = [];
+
+export type ErrorHandler = (error: ErrorSource) => string | undefined;
+
+export function registerErrorHandler(handler: ErrorHandler): void {
+    handlers.push(handler);
+}
+
+export function getErrorMessage(error: ErrorSource): string {
+    for (const handler of handlers) {
+        const result = handler(error);
+
+        if (result) {
+            return result;
+        }
+    }
+
+    if (typeof error === 'string') {
+        return error;
+    }
+
+    if (error instanceof Error || error instanceof JSError) {
+        return error.message;
+    }
+
+    if (isObject(error)) {
+        return toString(error['message'] ?? error['description'] ?? 'Unknown error object');
+    }
+
+    return translateWithDefault('errors.unknown', 'Unknown Error');
+}

package/src/forms/FormController.test.ts

@@ -0,0 +1,113 @@
+import { describe, expect, expectTypeOf, it } from 'vitest';
+import { tt } from '@noeldemartin/testing';
+import type { Equals } from '@noeldemartin/utils';
+import type { Expect } from '@noeldemartin/testing';
+
+import {
+    enumInput,
+    numberInput,
+    objectInput,
+    requiredObjectInput,
+    requiredStringInput,
+    stringInput,
+} from '@aerogel/core/forms/utils';
+import { useForm } from '@aerogel/core/utils/composition/forms';
+
+describe('FormController', () => {
+
+    it('defines magic fields', () => {
+        const form = useForm({
+            name: requiredStringInput(),
+            age: numberInput(),
+        });
+
+        expectTypeOf(form.name).toEqualTypeOf<string>();
+        expectTypeOf(form.age).toEqualTypeOf<number | null>();
+    });
+
+    it('validates required fields', () => {
+        // Arrange
+        const form = useForm({
+            name: {
+                type: 'string',
+                rules: 'required',
+            },
+        });
+
+        // Act
+        form.submit();
+
+        // Assert
+        expect(form.valid).toBe(false);
+        expect(form.submitted).toBe(true);
+        expect(form.errors.name).toEqual(['required']);
+    });
+
+    it('resets form', () => {
+        // Arrange
+        const form = useForm({
+            name: {
+                type: 'string',
+                rules: 'required',
+            },
+        });
+
+        form.name = 'Foo bar';
+        form.submit();
+
+        // Act
+        form.reset();
+
+        // Assert
+        expect(form.valid).toBe(true);
+        expect(form.submitted).toBe(false);
+        expect(form.name).toBeNull();
+    });
+
+    it('trims values', () => {
+        // Arrange
+        const form = useForm({
+            trimmed: {
+                type: 'string',
+                rules: 'required',
+            },
+            untrimmed: {
+                type: 'string',
+                rules: 'required',
+                trim: false,
+            },
+        });
+
+        // Act
+        form.trimmed = '   ';
+        form.untrimmed = '   ';
+
+        form.submit();
+
+        // Assert
+        expect(form.valid).toBe(false);
+        expect(form.submitted).toBe(true);
+        expect(form.trimmed).toEqual('');
+        expect(form.untrimmed).toEqual('   ');
+        expect(form.errors).toEqual({ trimmed: ['required'], untrimmed: null });
+    });
+
+    it('infers field types', () => {
+        const form = useForm({
+            one: stringInput(),
+            two: requiredStringInput(),
+            three: objectInput(),
+            four: requiredObjectInput<{ foo: string; bar?: number }>(),
+            five: enumInput(['foo', 'bar']),
+        });
+
+        tt<
+            | Expect<Equals<typeof form.one, string | null>>
+            | Expect<Equals<typeof form.two, string>>
+            | Expect<Equals<typeof form.three, object | null>>
+            | Expect<Equals<typeof form.four, { foo: string; bar?: number }>>
+            | Expect<Equals<typeof form.five, 'foo' | 'bar' | null>>
+        >();
+    });
+
+});