@aerogel/core 0.0.0-next.c8f032a868370824898e171969aec1bb6827688e → 0.0.0-next.f8cdd39997c56dcd46e07c26af8a84d04d610fce

package/src/components/modals/AGModal.vue

@@ -1,6 +1,11 @@
 <template>
-    <AGHeadlessModal v-slot="{ close }: IAGHeadlessModalDefaultSlotProps" class="relative z-50">
-        <div class="fixed inset-0 flex items-center justify-center">
+    <AGHeadlessModal
+        ref="$headlessModal"
+        v-slot="{ close }: IAGHeadlessModalDefaultSlotProps"
+        :cancellable="cancellable"
+        class="relative z-50"
+    >
+        <div class="fixed inset-0 flex items-center justify-center p-8">
             <AGHeadlessModalPanel class="flex max-h-full max-w-full flex-col overflow-hidden bg-white">
                 <div class="flex max-h-full flex-col overflow-auto p-4">
                     <slot :close="close" />
@@ -11,8 +16,21 @@
 </template>
 
 <script setup lang="ts">
-import type { IAGHeadlessModalDefaultSlotProps } from '@/components/headless/modals/AGHeadlessModal';
+import { computed, ref } from 'vue';
+
+import { booleanProp } from '@/utils';
+import type { IAGHeadlessModal, IAGHeadlessModalDefaultSlotProps } from '@/components/headless/modals/AGHeadlessModal';
+
+import type { IAGModal } from './AGModal';
 
 import AGHeadlessModal from '../headless/modals/AGHeadlessModal.vue';
 import AGHeadlessModalPanel from '../headless/modals/AGHeadlessModalPanel.vue';
+
+const $headlessModal = ref<IAGHeadlessModal>();
+
+defineProps({ cancellable: booleanProp(true) });
+defineExpose<IAGModal>({
+    close: async () => $headlessModal.value?.close(),
+    cancellable: computed(() => !!$headlessModal.value?.cancellable),
+});
 </script>

package/src/components/modals/index.ts

@@ -1,7 +1,21 @@
 import AGAlertModal from './AGAlertModal.vue';
 import AGConfirmModal from './AGConfirmModal.vue';
+import AGErrorReportModalButtons from './AGErrorReportModalButtons.vue';
+import AGErrorReportModalTitle from './AGErrorReportModalTitle.vue';
+import AGLoadingModal from './AGLoadingModal.vue';
 import AGModal from './AGModal.vue';
 import AGModalContext from './AGModalContext.vue';
-import { IAGModal } from './AGModal';
 
-export { AGAlertModal, AGConfirmModal, AGModal, AGModalContext, IAGModal };
+export * from './AGErrorReportModal';
+export * from './AGModal';
+export * from './AGModalContext';
+
+export {
+    AGAlertModal,
+    AGConfirmModal,
+    AGErrorReportModalButtons,
+    AGErrorReportModalTitle,
+    AGLoadingModal,
+    AGModal,
+    AGModalContext,
+};

package/src/components/snackbars/AGSnackbar.vue

@@ -0,0 +1,42 @@
+<template>
+    <AGHeadlessSnackbar class="flex flex-row items-center justify-center gap-3 p-4" :class="styleClasses">
+        <AGMarkdown :text="message" inline />
+        <AGButton
+            v-for="(action, i) of actions"
+            :key="i"
+            :color="color"
+            @click="activate(action)"
+        >
+            {{ action.text }}
+        </AGButton>
+    </AGHeadlessSnackbar>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import UI from '@/ui/UI';
+import { Colors } from '@/components/constants';
+import { useSnackbarProps } from '@/components/headless';
+import type { SnackbarAction } from '@/components/headless';
+
+import AGButton from '../forms/AGButton.vue';
+import AGHeadlessSnackbar from '../headless/snackbars/AGHeadlessSnackbar.vue';
+import AGMarkdown from '../basic/AGMarkdown.vue';
+
+const props = defineProps(useSnackbarProps());
+const styleClasses = computed(() => {
+    switch (props.color) {
+        case Colors.Danger:
+            return 'bg-red-200 text-red-900';
+        default:
+        case Colors.Secondary:
+            return 'bg-gray-900 text-white';
+    }
+});
+
+function activate(action: SnackbarAction): void {
+    action.handler?.();
+    action.dismiss && UI.hideSnackbar(props.id);
+}
+</script>

package/src/components/snackbars/index.ts

@@ -0,0 +1,3 @@
+import AGSnackbar from './AGSnackbar.vue';
+
+export { AGSnackbar };

package/src/directives/index.ts

@@ -4,12 +4,25 @@ import { definePlugin } from '@/plugins';
 
 import initialFocus from './initial-focus';
 
-const directives: Record<string, Directive> = {
+const builtInDirectives: Record<string, Directive> = {
     'initial-focus': initialFocus,
 };
 
 export default definePlugin({
-    install(app) {
-        Object.entries(directives).forEach(([name, directive]) => app.directive(name, directive));
+    install(app, options) {
+        const directives = {
+            ...builtInDirectives,
+            ...options.directives,
+        };
+
+        for (const [name, directive] of Object.entries(directives)) {
+            app.directive(name, directive);
+        }
     },
 });
+
+declare module '@/bootstrap/options' {
+    interface AerogelOptions {
+        directives?: Record<string, Directive>;
+    }
+}

package/src/errors/Errors.state.ts

@@ -0,0 +1,31 @@
+import type { JSError } from '@noeldemartin/utils';
+
+import { defineServiceState } from '@/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,183 @@
+import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+
+import App from '@/services/App';
+import ServiceBootError from '@/errors/ServiceBootError';
+import UI, { UIComponents } from '@/ui/UI';
+import { translateWithDefault } from '@/lang/utils';
+
+import Service from './Errors.state';
+import { Colors } from '@/components/constants';
+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[]): Promise<void> {
+        const reports = Array.isArray(error) ? error : [await this.createErrorReport(error)];
+
+        if (reports.length === 0) {
+            UI.alert(translateWithDefault('errors.inspectEmpty', 'Nothing to inspect!'));
+
+            return;
+        }
+
+        UI.openModal(UI.requireComponent(UIComponents.ErrorReportModal), { reports });
+    }
+
+    public async report(error: ErrorSource, message?: string): Promise<void> {
+        if (App.development || App.testing) {
+            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.showSnackbar(
+            message ??
+                translateWithDefault('errors.notice', 'Something went wrong, but it\'s not your fault. Try again!'),
+            {
+                color: Colors.Danger,
+                actions: [
+                    {
+                        text: translateWithDefault('errors.viewDetails', 'View details'),
+                        dismiss: true,
+                        handler: () =>
+                            UI.openModal(UI.requireComponent(UIComponents.ErrorReportModal), {
+                                reports: [report],
+                            }),
+                    },
+                ],
+            },
+        );
+
+        this.setState({ logs: [log].concat(this.logs) });
+    }
+
+    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,
+            })),
+        });
+    }
+
+    public getErrorMessage(error: ErrorSource): string {
+        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');
+    }
+
+    private logError(error: unknown): void {
+        // eslint-disable-next-line no-console
+        console.error(error);
+
+        if (isObject(error) && error.cause) {
+            this.logError(error.cause);
+        }
+    }
+
+    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(new ErrorsService());

package/src/errors/index.ts

@@ -0,0 +1,59 @@
+import { tap } from '@noeldemartin/utils';
+
+import { bootServices } from '@/services';
+import { definePlugin } from '@/plugins';
+
+import Errors from './Errors';
+import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+
+export { Errors, ErrorSource, ErrorReport, ErrorReportLog };
+
+const services = { $errors: Errors };
+const frameworkHandler: ErrorHandler = (error) => {
+    if (!Errors.instance) {
+        // eslint-disable-next-line no-console
+        console.warn('Errors service hasn\'t been initialized properly!');
+
+        // eslint-disable-next-line no-console
+        console.error(error);
+
+        return true;
+    }
+
+    Errors.report(error);
+
+    return true;
+};
+
+function setUpErrorHandler(baseHandler: ErrorHandler = () => false): ErrorHandler {
+    return tap(
+        (error) => baseHandler(error) || frameworkHandler(error),
+        (errorHandler) => {
+            globalThis.onerror = (message, _, __, ___, error) => errorHandler(error ?? message);
+            globalThis.onunhandledrejection = (event) => errorHandler(event.reason);
+        },
+    );
+}
+
+export type ErrorHandler = (error: ErrorSource) => boolean;
+export type ErrorsServices = typeof services;
+
+export default definePlugin({
+    async install(app, options) {
+        const errorHandler = setUpErrorHandler(options.handleError);
+
+        app.config.errorHandler = errorHandler;
+
+        await bootServices(app, services);
+    },
+});
+
+declare module '@/bootstrap/options' {
+    interface AerogelOptions {
+        handleError?(error: ErrorSource): boolean;
+    }
+}
+
+declare module '@/services' {
+    export interface Services extends ErrorsServices {}
+}

package/src/forms/Form.test.ts

@@ -34,4 +34,25 @@ describe('Form', () => {
         expect(form.errors.name).toEqual(['required']);
     });
 
+    it('resets form', () => {
+        // Arrange
+        const form = useForm({
+            name: {
+                type: FormFieldTypes.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();
+    });
+
 });

package/src/forms/Form.ts

@@ -6,6 +6,7 @@ import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
 export const FormFieldTypes = {
     String: 'string',
     Number: 'number',
+    Boolean: 'boolean',
 } as const;
 
 export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
@@ -18,7 +19,7 @@ export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
 export type FormFieldType = ObjectValues<typeof FormFieldTypes>;
 
 export type FormData<T> = {
-    [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
+    -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
         ? TRules extends 'required'
             ? GetFormFieldValue<TType>
             : GetFormFieldValue<TType> | null
@@ -33,6 +34,8 @@ export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.Strin
     ? string
     : TType extends typeof FormFieldTypes.Number
     ? number
+    : TType extends typeof FormFieldTypes.Boolean
+    ? boolean
     : never;
 
 export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
@@ -78,10 +81,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     }
 
     public validate(): boolean {
-        const errors = Object.entries(this._fields).reduce((errors, [name, definition]) => {
-            errors[name] = this.getFieldErrors(name, definition);
+        const errors = Object.entries(this._fields).reduce((formErrors, [name, definition]) => {
+            formErrors[name] = this.getFieldErrors(name, definition);
 
-            return errors;
+            return formErrors;
         }, {} as Record<string, string[] | null>);
 
         this.resetErrors(errors);
@@ -92,6 +95,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     public reset(): void {
         this._submitted.value = false;
 
+        this.resetData();
         this.resetErrors();
     }
 
@@ -134,10 +138,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             return {} as FormData<Fields>;
         }
 
-        const data = Object.entries(fields).reduce((data, [name, definition]) => {
-            data[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
+        const data = Object.entries(fields).reduce((formData, [name, definition]) => {
+            formData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
 
-            return data;
+            return formData;
         }, {} as FormData<Fields>);
 
         return reactive(data) as FormData<Fields>;
@@ -148,15 +152,21 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             return {} as FormErrors<Fields>;
         }
 
-        const errors = Object.keys(fields).reduce((errors, name) => {
-            errors[name as keyof Fields] = null;
+        const errors = Object.keys(fields).reduce((formErrors, name) => {
+            formErrors[name as keyof Fields] = null;
 
-            return errors;
+            return formErrors;
         }, {} as FormErrors<Fields>);
 
         return reactive(errors) as FormErrors<Fields>;
     }
 
+    private resetData(): void {
+        for (const [name, field] of Object.entries(this._fields)) {
+            this._data[name as keyof Fields] = (field.default ?? null) as FormData<Fields>[keyof Fields];
+        }
+    }
+
     private resetErrors(errors?: Record<string, string[] | null>): void {
         Object.keys(this._errors).forEach((key) => delete this._errors[key as keyof Fields]);
 

package/src/forms/utils.ts

@@ -1,6 +1,23 @@
 import { FormFieldTypes } from './Form';
 import type { FormFieldDefinition } from './Form';
 
+export function booleanInput(defaultValue?: boolean): FormFieldDefinition<typeof FormFieldTypes.Boolean> {
+    return {
+        default: defaultValue,
+        type: FormFieldTypes.Boolean,
+    };
+}
+
+export function requiredBooleanInput(
+    defaultValue?: boolean,
+): FormFieldDefinition<typeof FormFieldTypes.Boolean, 'required'> {
+    return {
+        default: defaultValue,
+        type: FormFieldTypes.Boolean,
+        rules: 'required',
+    };
+}
+
 export function requiredNumberInput(
     defaultValue?: number,
 ): FormFieldDefinition<typeof FormFieldTypes.Number, 'required'> {

package/src/lang/Lang.ts

@@ -1,4 +1,4 @@
-import { facade } from '@noeldemartin/utils';
+import { facade, toString } from '@noeldemartin/utils';
 
 import App from '@/services/App';
 import Service from '@/services/Service';
@@ -17,7 +17,7 @@ export class LangService extends Service {
         this.provider = {
             translate: (key) => {
                 // eslint-disable-next-line no-console
-                App.isDevelopment && console.warn('Lang provider is missing');
+                App.development && console.warn('Lang provider is missing');
 
                 return key;
             },
@@ -41,10 +41,18 @@ export class LangService extends Service {
     ): string {
         defaultMessage ??= defaultMessageOrParameters as string;
 
-        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters;
+        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters ?? {};
         const message = this.provider.translate(key, parameters) ?? key;
 
-        return message === key ? defaultMessage : message;
+        if (message === key) {
+            return Object.entries(parameters).reduce(
+                (renderedMessage, [name, value]) =>
+                    renderedMessage.replace(new RegExp(`\\{\\s*${name}\\s*\\}`, 'g'), toString(value)),
+                defaultMessage,
+            );
+        }
+
+        return message;
     }
 
 }

package/src/lang/index.ts

@@ -2,16 +2,14 @@ import { bootServices } from '@/services';
 import { definePlugin } from '@/plugins';
 
 import Lang, { LangProvider } from './Lang';
+import { translate, translateWithDefault } from './utils';
 
-export { Lang, LangProvider };
+export { Lang, LangProvider, translate, translateWithDefault };
 
 const services = { $lang: Lang };
 
 export type LangServices = typeof services;
 
-export const translate = Lang.translate.bind(Lang);
-export const translateWithDefault = Lang.translateWithDefault.bind(Lang);
-
 export default definePlugin({
     async install(app) {
         app.config.globalProperties.$t ??= translate;
@@ -22,7 +20,7 @@ export default definePlugin({
 });
 
 declare module '@/services' {
-    interface Services extends LangServices {}
+    export interface Services extends LangServices {}
 }
 
 declare module '@vue/runtime-core' {

package/src/lang/utils.ts

@@ -0,0 +1,4 @@
+import Lang from './Lang';
+
+export const translate = Lang.translate.bind(Lang);
+export const translateWithDefault = Lang.translateWithDefault.bind(Lang);

package/src/main.ts

@@ -1,7 +1,6 @@
-import './globals';
-
 export * from './bootstrap';
 export * from './components';
+export * from './errors';
 export * from './forms';
 export * from './lang';
 export * from './plugins';

package/src/services/App.state.ts

@@ -1,10 +1,16 @@
+import Build from 'virtual:aerogel';
+
 import { defineServiceState } from '@/services/Service';
 
 export default defineServiceState({
+    name: 'app',
     initialState: {
-        environment: __AG_ENV,
+        environment: Build.environment,
+        sourceUrl: Build.sourceUrl,
+        isMounted: false,
     },
     computed: {
-        isDevelopment: (state) => state.environment === 'development',
+        development: (state) => state.environment === 'development',
+        testing: (state) => state.environment === 'testing',
     },
 });

package/src/services/App.ts

@@ -1,7 +1,15 @@
 import { facade } from '@noeldemartin/utils';
 
+import Events from '@/services/Events';
+
 import Service from './App.state';
 
-export class AppService extends Service {}
+export class AppService extends Service {
+
+    protected async boot(): Promise<void> {
+        Events.once('application-mounted', () => this.setState({ isMounted: true }));
+    }
+
+}
 
 export default facade(new AppService());