@aerogel/core 0.0.0-next.7f6ed5a1f91688a86bf5ede2adc465e4fd6cfdea → 0.0.0-next.88c59e62f64db70aedfbc4c31b5bbc287be44483

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

@@ -1,11 +1,13 @@
 import { MagicObject } from '@noeldemartin/utils';
-import { reactive, readonly, ref } from 'vue';
+import { computed, reactive, readonly, ref } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
-import type { DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
+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> {
@@ -18,7 +20,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 +35,10 @@ 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;
 
 export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
@@ -41,7 +47,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
 
     private _fields: Fields;
     private _data: FormData<Fields>;
-    private _valid: Ref<boolean>;
+    private _valid: ComputedRef<boolean>;
     private _submitted: Ref<boolean>;
     private _errors: FormErrors<Fields>;
 
@@ -50,9 +56,9 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
 
         this._fields = fields;
         this._submitted = ref(false);
-        this._valid = ref(true);
         this._data = this.getInitialData(fields);
         this._errors = this.getInitialErrors(fields);
+        this._valid = computed(() => !Object.values(this._errors).some((error) => error !== null));
 
         this.errors = readonly(this._errors);
     }
@@ -78,15 +84,22 @@ 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>);
 
-        Object.assign(this._errors, errors);
+        this.resetErrors(errors);
 
-        return (this._valid.value = !Object.values(errors).some((error) => error !== null));
+        return this.valid;
+    }
+
+    public reset(options: { keepData?: boolean; keepErrors?: boolean } = {}): void {
+        this._submitted.value = false;
+
+        options.keepData || this.resetData();
+        options.keepErrors || this.resetErrors();
     }
 
     public submit(): boolean {
@@ -128,10 +141,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>;
@@ -142,13 +155,25 @@ 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]);
+
+        errors && Object.assign(this._errors, errors);
+    }
+
 }

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,19 +1,58 @@
-import { useI18n } from 'vue-i18n';
-import { facade } from '@noeldemartin/utils';
-import type { Composer } from 'vue-i18n';
+import { facade, toString } from '@noeldemartin/utils';
 
+import App from '@/services/App';
 import Service from '@/services/Service';
 
+export interface LangProvider {
+    translate(key: string, parameters?: Record<string, unknown>): string;
+}
+
 export class LangService extends Service {
 
-    private i18n?: Composer;
+    private provider: LangProvider;
+
+    constructor() {
+        super();
+
+        this.provider = {
+            translate: (key) => {
+                // eslint-disable-next-line no-console
+                App.development && console.warn('Lang provider is missing');
+
+                return key;
+            },
+        };
+    }
 
-    public setup(): void {
-        this.i18n = useI18n();
+    public setProvider(provider: LangProvider): void {
+        this.provider = provider;
     }
 
-    public translate(key: string, parameters: Record<string, unknown> = {}): string {
-        return this.i18n?.t(key, parameters) ?? key;
+    public translate(key: string, parameters?: Record<string, unknown>): string {
+        return this.provider.translate(key, parameters) ?? key;
+    }
+
+    public translateWithDefault(key: string, defaultMessage: string): string;
+    public translateWithDefault(key: string, parameters: Record<string, unknown>, defaultMessage: string): string;
+    public translateWithDefault(
+        key: string,
+        defaultMessageOrParameters?: string | Record<string, unknown>,
+        defaultMessage?: string,
+    ): string {
+        defaultMessage ??= defaultMessageOrParameters as string;
+
+        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters ?? {};
+        const message = this.provider.translate(key, parameters) ?? key;
+
+        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

@@ -1,89 +1,30 @@
-import { createI18n } from 'vue-i18n';
-import { fail, stringMatch } from '@noeldemartin/utils';
-import type { I18nOptions } from 'vue-i18n';
-import type { Plugin } from 'vue';
-
-import { defineBootstrapHook, onAppMounted } from '@/bootstrap/hooks';
 import { bootServices } from '@/services';
-import type { BootstrapOptions } from '@/bootstrap/options';
-
-import Lang from './Lang';
-
-const services = { $lang: Lang };
-
-function getLangOptions(options: BootstrapOptions): LangOptions | null {
-    if (options.lang) {
-        return options.lang;
-    }
-
-    if (options.langMessages) {
-        return { messages: options.langMessages };
-    }
-
-    return null;
-}
+import { definePlugin } from '@/plugins';
 
-function getMessageLoaders(messageLoaders: Record<string, unknown>): Record<string, LazyMessages> {
-    return Object.entries(messageLoaders).reduce((loaders, [fileName, loader]) => {
-        const locale = stringMatch<2>(fileName, /.*\/lang\/(.+)\.yaml/)?.[1];
+import Lang, { LangProvider } from './Lang';
+import { translate, translateWithDefault } from './utils';
 
-        if (locale) {
-            loaders[locale] = () =>
-                (loader as () => Promise<{ default: Record<string, unknown> }>)().then(
-                    ({ default: messages }) => messages,
-                );
-        }
+export { Lang, LangProvider, translate, translateWithDefault };
 
-        return loaders;
-    }, {} as Record<string, LazyMessages>);
-}
-
-async function createAppI18n(options: LangOptions): Promise<Plugin> {
-    const locale = options.defaultLocale ?? 'en';
-    const fallbackLocale = options.fallbackLocale ?? 'en';
-    const messageLoaders = getMessageLoaders(options.messages);
-    const lazyMessages = messageLoaders[locale] ?? fail<LazyMessages>(`Missing messages for '${locale}' locale`);
-    const messages = { [locale]: await lazyMessages() } as I18nOptions['messages'];
-
-    return createI18n({ locale, fallbackLocale, messages });
-}
+const services = { $lang: Lang };
 
 export type LangServices = typeof services;
 
-export type LazyMessages = () => Promise<Record<string, unknown>>;
-
-export interface LangOptions {
-    messages: Record<string, unknown>;
-    defaultLocale?: string;
-    fallbackLocale?: string;
-}
-
-export * from './helpers';
-export { Lang };
-
-export default defineBootstrapHook(async (app, options) => {
-    const langOptions = getLangOptions(options);
-
-    if (!langOptions) {
-        return;
-    }
-
-    onAppMounted(() => Lang.setup());
-
-    const plugin = await createAppI18n(langOptions);
+export default definePlugin({
+    async install(app) {
+        app.config.globalProperties.$t ??= translate;
+        app.config.globalProperties.$td = translateWithDefault;
 
-    app.use(plugin);
-
-    await bootServices(app, services);
+        await bootServices(app, services);
+    },
 });
 
-declare module '@/bootstrap/options' {
-    interface BootstrapOptions {
-        lang?: LangOptions;
-        langMessages?: Record<string, unknown>;
-    }
+declare module '@/services' {
+    export interface Services extends LangServices {}
 }
 
-declare module '@/services' {
-    interface Services extends LangServices {}
+declare module '@vue/runtime-core' {
+    interface ComponentCustomProperties {
+        $td: typeof translateWithDefault;
+    }
 }

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,9 @@
 export * from './bootstrap';
 export * from './components';
+export * from './errors';
 export * from './forms';
 export * from './lang';
+export * from './plugins';
 export * from './services';
 export * from './ui';
 export * from './utils';

package/src/plugins/Plugin.ts

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,26 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import App from '@/services/App';
+
+import type { Plugin } from './Plugin';
+
+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

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

package/src/services/App.ts

@@ -0,0 +1,20 @@
+import { facade } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
+import type { Plugin } from '@/plugins';
+
+import Service from './App.state';
+
+export class AppService extends Service {
+
+    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-mounted', () => this.setState({ isMounted: true }));
+    }
+
+}
+
+export default facade(new AppService());