@aerogel/core 0.0.0-next.f16bd1d894543c5303039c49f6f33488a1ffe931 → 0.0.0-next.f1f5a990033d966dc0bb12d251110fbc9350dcc7

package/src/components/snackbars/AGSnackbar.vue

@@ -1,6 +1,6 @@
 <template>
     <AGHeadlessSnackbar class="flex flex-row items-center justify-center gap-3 p-4" :class="styleClasses">
-        <AGMarkdown :text="message" raw />
+        <AGMarkdown :text="message" inline />
         <AGButton
             v-for="(action, i) of actions"
             :key="i"
@@ -15,16 +15,15 @@
 <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 { useSnackbar, useSnackbarProps } from '@/components/headless/snackbars';
 
 import AGButton from '../forms/AGButton.vue';
 import AGHeadlessSnackbar from '../headless/snackbars/AGHeadlessSnackbar.vue';
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
 const props = defineProps(useSnackbarProps());
+const { activate } = useSnackbar(props);
 const styleClasses = computed(() => {
     switch (props.color) {
         case Colors.Danger:
@@ -34,9 +33,4 @@ const styleClasses = computed(() => {
             return 'bg-gray-900 text-white';
     }
 });
-
-function activate(action: SnackbarAction): void {
-    action.handler?.();
-    action.dismiss && UI.hideSnackbar(props.id);
-}
 </script>

package/src/components/utils.ts

@@ -0,0 +1,10 @@
+export function extractComponentProps<T extends Record<string, unknown>>(
+    values: Record<string, unknown>,
+    definitions: Record<string, unknown>,
+): T {
+    return Object.keys(definitions).reduce((extracted, prop) => {
+        extracted[prop] = values[prop];
+
+        return extracted;
+    }, {} as Record<string, unknown>) as T;
+}

package/src/directives/index.ts

@@ -3,9 +3,11 @@ import type { Directive } from 'vue';
 import { definePlugin } from '@/plugins';
 
 import initialFocus from './initial-focus';
+import measure from './measure';
 
 const builtInDirectives: Record<string, Directive> = {
     'initial-focus': initialFocus,
+    'measure': measure,
 };
 
 export default definePlugin({
@@ -22,7 +24,7 @@ export default definePlugin({
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         directives?: Record<string, Directive>;
     }
 }

package/src/directives/measure.ts

@@ -0,0 +1,12 @@
+import { defineDirective } from '@/utils/vue';
+
+export default defineDirective({
+    mounted(element: HTMLElement, { value }: { value?: () => unknown }) {
+        const sizes = element.getBoundingClientRect();
+
+        element.style.setProperty('--width', `${sizes.width}px`);
+        element.style.setProperty('--height', `${sizes.height}px`);
+
+        value?.();
+    },
+});

package/src/errors/Errors.ts

@@ -3,11 +3,13 @@ import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noelde
 import App from '@/services/App';
 import ServiceBootError from '@/errors/ServiceBootError';
 import UI, { UIComponents } from '@/ui/UI';
-import { translate, translateWithDefault } from '@/lang/utils';
+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 {
 
@@ -23,7 +25,7 @@ export class ErrorsService extends Service {
     }
 
     public async inspect(error: ErrorSource | ErrorReport[]): Promise<void> {
-        const reports = Array.isArray(error) ? error : [await this.createErrorReport(error)];
+        const reports = Array.isArray(error) ? (error as ErrorReport[]) : [await this.createErrorReport(error)];
 
         if (reports.length === 0) {
             UI.alert(translateWithDefault('errors.inspectEmpty', 'Nothing to inspect!'));
@@ -31,11 +33,13 @@ export class ErrorsService extends Service {
             return;
         }
 
-        UI.openModal(UI.requireComponent(UIComponents.ErrorReportModal), { reports });
+        UI.openModal<ModalComponent<AGErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
+            reports,
+        });
     }
 
     public async report(error: ErrorSource, message?: string): Promise<void> {
-        if (App.isDevelopment || App.isTesting) {
+        if (App.development || App.testing) {
             this.logError(error);
         }
 
@@ -70,9 +74,10 @@ export class ErrorsService extends Service {
                         text: translateWithDefault('errors.viewDetails', 'View details'),
                         dismiss: true,
                         handler: () =>
-                            UI.openModal(UI.requireComponent(UIComponents.ErrorReportModal), {
-                                reports: [report],
-                            }),
+                            UI.openModal<ModalComponent<AGErrorReportModalProps>>(
+                                UI.requireComponent(UIComponents.ErrorReportModal),
+                                { reports: [report] },
+                            ),
                     },
                 ],
             },
@@ -105,6 +110,22 @@ export class ErrorsService extends Service {
         });
     }
 
+    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);
@@ -125,14 +146,20 @@ export class ErrorsService extends Service {
 
         if (isObject(error)) {
             return objectWithoutEmpty({
-                title: toString(error['name'] ?? error['title'] ?? translate('errors.unknown')),
-                description: toString(error['message'] ?? error['description'] ?? ''),
+                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: translate('errors.unknown'),
+            title: translateWithDefault('errors.unknown', 'Unknown Error'),
             error,
         };
     }

package/src/errors/index.ts

@@ -1,4 +1,4 @@
-import { tap } from '@noeldemartin/utils';
+import type { App } from 'vue';
 
 import { bootServices } from '@/services';
 import { definePlugin } from '@/plugins';
@@ -25,14 +25,12 @@ const frameworkHandler: ErrorHandler = (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);
-        },
-    );
+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;
@@ -40,16 +38,14 @@ export type ErrorsServices = typeof services;
 
 export default definePlugin({
     async install(app, options) {
-        const errorHandler = setUpErrorHandler(options.handleError);
-
-        app.config.errorHandler = errorHandler;
+        setUpErrorHandler(app, options.handleError);
 
         await bootServices(app, services);
     },
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         handleError?(error: ErrorSource): boolean;
     }
 }

package/src/forms/Form.ts

@@ -7,6 +7,7 @@ export const FormFieldTypes = {
     String: 'string',
     Number: 'number',
     Boolean: 'boolean',
+    Object: 'object',
 } as const;
 
 export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
@@ -36,15 +37,18 @@ export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.Strin
     ? 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>;
 
@@ -55,13 +59,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 {
@@ -92,11 +100,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 {

package/src/lang/Lang.ts

@@ -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;
             },

package/src/main.histoire.ts

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

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

package/src/services/App.ts

@@ -1,14 +1,26 @@
-import { facade } from '@noeldemartin/utils';
+import { 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 {
 
-    protected async boot(): Promise<void> {
-        await super.boot();
+    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-mounted', () => this.setState({ isMounted: true }));
     }
 

package/src/services/Service.ts

@@ -93,7 +93,8 @@ export default class Service<
         const handleError = (error: unknown) => this._booted.reject(new ServiceBootError(this._name, error));
 
         try {
-            this.boot()
+            this.frameworkBoot()
+                .then(() => this.boot())
                 .then(() => this._booted.resolve())
                 .catch(handleError);
         } catch (error) {
@@ -161,7 +162,11 @@ export default class Service<
             return;
         }
 
-        const storage = Storage.require<ServiceStorage>(this._name);
+        const storage = Storage.get<ServiceStorage>(this._name);
+
+        if (!storage) {
+            return;
+        }
 
         Storage.set(this._name, {
             ...storage,
@@ -189,11 +194,15 @@ export default class Service<
         return state;
     }
 
+    protected async frameworkBoot(): Promise<void> {
+        this.initializePersistedState();
+    }
+
     protected async boot(): Promise<void> {
-        this.restorePersistedState();
+        // Placeholder for overrides, don't place any functionality here.
     }
 
-    protected restorePersistedState(): void {
+    protected initializePersistedState(): void {
         // TODO fix this.static()
         const persist = (this.constructor as unknown as { persist: string[] }).persist;
 

package/src/services/index.ts

@@ -24,13 +24,16 @@ export interface Services extends DefaultServices {}
 
 export async function bootServices(app: VueApp, services: Record<string, Service>): Promise<void> {
     await Promise.all(
-        Object.entries(services).map(async ([_, service]) => {
-            // eslint-disable-next-line no-console
-            await service.launch().catch((error) => console.error(error));
+        Object.entries(services).map(async ([name, service]) => {
+            await service
+                .launch()
+                .catch((error) => app.config.errorHandler?.(error, null, `Failed launching ${name}.`));
         }),
     );
 
     Object.assign(app.config.globalProperties, services);
+
+    App.development && Object.assign(window, services);
 }
 
 export default definePlugin({
@@ -47,7 +50,7 @@ export default definePlugin({
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         services?: Record<string, Service>;
     }
 }

package/src/ui/UI.ts

@@ -1,4 +1,4 @@
-import { facade, fail, uuid } from '@noeldemartin/utils';
+import { after, facade, fail, uuid } from '@noeldemartin/utils';
 import { markRaw, nextTick } from 'vue';
 import type { Component } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
@@ -8,6 +8,7 @@ import type { SnackbarAction, SnackbarColor } from '@/components/headless/snackb
 
 import Service from './UI.state';
 import type { Modal, ModalComponent, Snackbar } from './UI.state';
+import type { AGAlertModalProps, AGConfirmModalProps, AGLoadingModalProps } from '@/components';
 
 interface ModalCallbacks<T = unknown> {
     willClose(result: T | undefined): void;
@@ -25,10 +26,16 @@ export const UIComponents = {
     ErrorReportModal: 'error-report-modal',
     LoadingModal: 'loading-modal',
     Snackbar: 'snackbar',
+    StartupCrash: 'startup-crash',
 } as const;
 
 export type UIComponent = ObjectValues<typeof UIComponents>;
 
+export interface ConfirmOptions {
+    acceptText?: string;
+    cancelText?: string;
+}
+
 export interface ShowSnackbarOptions {
     component?: Component;
     color?: SnackbarColor;
@@ -47,18 +54,45 @@ export class UIService extends Service {
     public alert(message: string): void;
     public alert(title: string, message: string): void;
     public alert(messageOrTitle: string, message?: string): void {
-        const options = typeof message === 'string' ? { title: messageOrTitle, message } : { message: messageOrTitle };
+        const getProperties = (): AGAlertModalProps => {
+            if (typeof message !== 'string') {
+                return { message: messageOrTitle };
+            }
 
-        this.openModal(this.requireComponent(UIComponents.AlertModal), options);
+            return {
+                title: messageOrTitle,
+                message,
+            };
+        };
+
+        this.openModal(this.requireComponent(UIComponents.AlertModal), getProperties());
     }
 
-    public async confirm(message: string): Promise<boolean>;
-    public async confirm(title: string, message: string): Promise<boolean>;
-    public async confirm(messageOrTitle: string, message?: string): Promise<boolean> {
-        const options = typeof message === 'string' ? { title: messageOrTitle, message } : { message: messageOrTitle };
+    public async confirm(message: string, options?: ConfirmOptions): Promise<boolean>;
+    public async confirm(title: string, message: string, options?: ConfirmOptions): Promise<boolean>;
+    public async confirm(
+        messageOrTitle: string,
+        messageOrOptions?: string | ConfirmOptions,
+        options?: ConfirmOptions,
+    ): Promise<boolean> {
+        const getProperties = (): AGConfirmModalProps => {
+            if (typeof messageOrOptions !== 'string') {
+                return {
+                    message: messageOrTitle,
+                    ...(messageOrOptions ?? {}),
+                };
+            }
+
+            return {
+                title: messageOrTitle,
+                message: messageOrOptions,
+                ...(options ?? {}),
+            };
+        };
+
         const modal = await this.openModal<ModalComponent<{ message: string }, boolean>>(
             this.requireComponent(UIComponents.ConfirmModal),
-            options,
+            getProperties(),
         );
         const result = await modal.beforeClose;
 
@@ -68,15 +102,25 @@ export class UIService extends Service {
     public async loading<T>(operation: Promise<T>): Promise<T>;
     public async loading<T>(message: string, operation: Promise<T>): Promise<T>;
     public async loading<T>(messageOrOperation: string | Promise<T>, operation?: Promise<T>): Promise<T> {
-        operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
+        const getProperties = (): AGLoadingModalProps => {
+            if (typeof messageOrOperation !== 'string') {
+                return {};
+            }
+
+            return { message: messageOrOperation };
+        };
 
-        const message = typeof messageOrOperation === 'string' ? messageOrOperation : undefined;
-        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), { message });
-        const result = await operation;
+        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
 
-        await this.closeModal(modal.id);
+        try {
+            operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
 
-        return result;
+            const [result] = await Promise.all([operation, after({ seconds: 1 })]);
+
+            return result;
+        } finally {
+            await this.closeModal(modal.id);
+        }
     }
 
     public showSnackbar(message: string, options: ShowSnackbarOptions = {}): void {
@@ -137,9 +181,8 @@ export class UIService extends Service {
     }
 
     protected async boot(): Promise<void> {
-        await super.boot();
-
         this.watchModalEvents();
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -167,6 +210,24 @@ export class UIService extends Service {
         });
     }
 
+    private watchMountedEvent(): void {
+        Events.once('application-mounted', async () => {
+            const splash = document.getElementById('splash');
+
+            if (!splash) {
+                return;
+            }
+
+            if (window.getComputedStyle(splash).opacity !== '0') {
+                splash.style.opacity = '0';
+
+                await after({ ms: 600 });
+            }
+
+            splash.remove();
+        });
+    }
+
 }
 
 export default facade(new UIService());

package/src/ui/index.ts

@@ -9,12 +9,14 @@ import AGConfirmModal from '../components/modals/AGConfirmModal.vue';
 import AGErrorReportModal from '../components/modals/AGErrorReportModal.vue';
 import AGLoadingModal from '../components/modals/AGLoadingModal.vue';
 import AGSnackbar from '../components/snackbars/AGSnackbar.vue';
+import AGStartupCrash from '../components/lib/AGStartupCrash.vue';
 import type { UIComponent } from './UI';
 
-export { UI, UIComponents, UIComponent };
-
 const services = { $ui: UI };
 
+export * from './UI';
+export { default as UI } from './UI';
+
 export type UIServices = typeof services;
 
 export default definePlugin({
@@ -25,6 +27,7 @@ export default definePlugin({
             [UIComponents.ErrorReportModal]: AGErrorReportModal,
             [UIComponents.LoadingModal]: AGLoadingModal,
             [UIComponents.Snackbar]: AGSnackbar,
+            [UIComponents.StartupCrash]: AGStartupCrash,
         };
 
         Object.entries({
@@ -37,7 +40,7 @@ export default definePlugin({
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         components?: Partial<Record<UIComponent, Component>>;
     }
 }

package/src/utils/composition/events.ts

@@ -14,6 +14,7 @@ export function useEvent<Event extends EventWithPayload>(
     event: Event,
     listener: EventListener<EventsPayload[Event]>
 ): void;
+export function useEvent<Payload>(event: string, listener: (payload: Payload) => unknown): void;
 export function useEvent<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): void;
 
 export function useEvent(event: string, listener: EventListener): void {

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './composition/events';
 export * from './composition/forms';
 export * from './composition/hooks';
+export * from './tailwindcss';
 export * from './vue';