@aerogel/core 0.0.0-next.926bde19326fe7b6b24b277666936862b64d8295 → 0.0.0-next.97312fd206b83ac5ae520da32b1bb3f12fb55969

package/src/errors/Errors.ts

@@ -0,0 +1,188 @@
+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 { AGErrorReportModalProps } from '@/components/modals/AGErrorReportModal';
+import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+import type { ModalComponent } from '@/ui/UI.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 as ErrorReport[]) : [await this.createErrorReport(error)];
+
+        if (reports.length === 0) {
+            UI.alert(translateWithDefault('errors.inspectEmpty', 'Nothing to inspect!'));
+
+            return;
+        }
+
+        UI.openModal<ModalComponent<AGErrorReportModalProps>>(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<ModalComponent<AGErrorReportModalProps>>(
+                                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,55 @@
+import type { App } from 'vue';
+
+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(app: App, 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);
+
+        await bootServices(app, services);
+    },
+});
+
+declare module '@/bootstrap/options' {
+    export interface AerogelOptions {
+        handleError?(error: ErrorSource): boolean;
+    }
+}
+
+declare module '@/services' {
+    export interface Services extends ErrorsServices {}
+}

package/src/forms/Form.ts

@@ -6,6 +6,8 @@ import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
 export const FormFieldTypes = {
     String: 'string',
     Number: 'number',
+    Boolean: 'boolean',
+    Object: 'object',
 } as const;
 
 export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
@@ -16,6 +18,7 @@ export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType
 
 export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
 export type FormFieldType = ObjectValues<typeof FormFieldTypes>;
+export type FormFieldValue = GetFormFieldValue<FormFieldType>;
 
 export type FormData<T> = {
     -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
@@ -33,15 +36,20 @@ export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.Strin
     ? string
     : TType extends typeof FormFieldTypes.Number
     ? number
+    : TType extends typeof FormFieldTypes.Boolean
+    ? boolean
+    : TType extends typeof FormFieldTypes.Object
+    ? object
     : never;
 
+const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
+
 export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
 
     public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
 
     private _fields: Fields;
     private _data: FormData<Fields>;
-    private _valid: ComputedRef<boolean>;
     private _submitted: Ref<boolean>;
     private _errors: FormErrors<Fields>;
 
@@ -52,13 +60,17 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         this._submitted = ref(false);
         this._data = this.getInitialData(fields);
         this._errors = this.getInitialErrors(fields);
-        this._valid = computed(() => !Object.values(this._errors).some((error) => error !== null));
+
+        validForms.set(
+            this,
+            computed(() => !Object.values(this._errors).some((error) => error !== null)),
+        );
 
         this.errors = readonly(this._errors);
     }
 
     public get valid(): boolean {
-        return this._valid.value;
+        return !!validForms.get(this)?.value;
     }
 
     public get submitted(): boolean {
@@ -78,10 +90,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);
@@ -89,11 +101,11 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         return this.valid;
     }
 
-    public reset(): void {
+    public reset(options: { keepData?: boolean; keepErrors?: boolean } = {}): void {
         this._submitted.value = false;
 
-        this.resetData();
-        this.resetErrors();
+        options.keepData || this.resetData();
+        options.keepErrors || this.resetErrors();
     }
 
     public submit(): boolean {
@@ -135,10 +147,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>;
@@ -149,10 +161,10 @@ 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>;

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.histoire.ts

@@ -0,0 +1 @@
+import './assets/histoire.css';

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/plugins/Plugin.ts

@@ -3,5 +3,6 @@ import type { App } from 'vue';
 import type { AerogelOptions } from '@/bootstrap/options';
 
 export interface Plugin {
+    name?: string;
     install(app: App, options: AerogelOptions): void | Promise<void>;
 }

package/src/plugins/index.ts

@@ -1,3 +1,7 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import App from '@/services/App';
+
 import type { Plugin } from './Plugin';
 
 export * from './Plugin';
@@ -5,3 +9,18 @@ export * from './Plugin';
 export function definePlugin<T extends Plugin>(plugin: T): T {
     return plugin;
 }
+
+export async function installPlugins(plugins: Plugin[], ...args: GetClosureArgs<Plugin['install']>): Promise<void> {
+    App.setState(
+        'plugins',
+        plugins.reduce((pluginsMap, plugin) => {
+            if (plugin.name) {
+                pluginsMap[plugin.name] = plugin;
+            }
+
+            return pluginsMap;
+        }, {} as Record<string, Plugin>),
+    );
+
+    await Promise.all(plugins.map((plugin) => plugin.install(...args)) ?? []);
+}

package/src/services/App.state.ts

@@ -1,10 +1,17 @@
+import Aerogel from 'virtual:aerogel';
+
 import { defineServiceState } from '@/services/Service';
+import type { Plugin } from '@/plugins/Plugin';
 
 export default defineServiceState({
+    name: 'app',
     initialState: {
-        environment: __AG_ENV,
+        plugins: {} as Record<string, Plugin>,
+        environment: Aerogel.environment,
+        sourceUrl: Aerogel.sourceUrl,
     },
     computed: {
-        isDevelopment: (state) => state.environment === 'development',
+        development: (state) => state.environment === 'development',
+        testing: (state) => state.environment === 'testing',
     },
 });

package/src/services/App.ts

@@ -1,7 +1,41 @@
-import { facade } from '@noeldemartin/utils';
+import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
+import type { Plugin } from '@/plugins';
 
 import Service from './App.state';
 
-export class AppService extends Service {}
+export class AppService extends Service {
+
+    public readonly ready = new PromisedValue<void>();
+    public readonly mounted = new PromisedValue<void>();
+
+    public isReady(): boolean {
+        return this.ready.isResolved();
+    }
+
+    public isMounted(): boolean {
+        return this.mounted.isResolved();
+    }
+
+    public async reload(queryParameters?: Record<string, string | undefined>): Promise<void> {
+        queryParameters && updateLocationQueryParameters(queryParameters);
+
+        location.reload();
+
+        // Stall until the reload happens
+        await forever();
+    }
+
+    public plugin<T extends Plugin = Plugin>(name: string): T | null {
+        return (this.plugins[name] as T) ?? null;
+    }
+
+    protected async boot(): Promise<void> {
+        Events.once('application-ready', () => this.ready.resolve());
+        Events.once('application-mounted', () => this.mounted.resolve());
+    }
+
+}
 
 export default facade(new AppService());