@aerogel/core 0.0.0-next.9487bb13082b9d479112445804d906125ded5cbc → 0.0.0-next.97312fd206b83ac5ae520da32b1bb3f12fb55969

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

@@ -7,7 +7,9 @@ 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,7 +33,9 @@ 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> {
@@ -43,7 +47,7 @@ export class ErrorsService extends Service {
             throw error;
         }
 
-        if (!App.isMounted) {
+        if (!App.isMounted()) {
             const startupError = await this.createStartupErrorReport(error);
 
             if (startupError) {
@@ -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] },
+                            ),
                     },
                 ],
             },

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

@@ -18,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>

package/src/services/App.state.ts

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

package/src/services/App.ts

@@ -1,4 +1,4 @@
-import { facade } from '@noeldemartin/utils';
+import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
 
 import Events from '@/services/Events';
 import type { Plugin } from '@/plugins';
@@ -7,12 +7,33 @@ import Service from './App.state';
 
 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-mounted', () => this.setState({ isMounted: true }));
+        Events.once('application-ready', () => this.ready.resolve());
+        Events.once('application-mounted', () => this.mounted.resolve());
     }
 
 }

package/src/services/Service.ts

@@ -1,5 +1,6 @@
 import { MagicObject, PromisedValue, Storage, isEmpty, objectDeepClone, objectOnly } from '@noeldemartin/utils';
 import type { Constructor } from '@noeldemartin/utils';
+import type { MaybeRef } from 'vue';
 import type { Store } from 'pinia';
 
 import ServiceBootError from '@/errors/ServiceBootError';
@@ -8,6 +9,9 @@ import { defineServiceStore } from '@/services/store';
 export type ServiceState = Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
 export type DefaultServiceState = any; // eslint-disable-line @typescript-eslint/no-explicit-any
 export type ServiceConstructor<T extends Service = Service> = Constructor<T> & typeof Service;
+export type UnrefServiceState<State extends ServiceState> = {
+    [K in keyof State]: State[K] extends MaybeRef<infer T> ? T : State[K];
+};
 
 export type ComputedStateDefinition<TState extends ServiceState, TComputedState extends ServiceState> = {
     [K in keyof TComputedState]: (state: TState) => TComputedState[K];
@@ -24,8 +28,10 @@ export function defineServiceState<
     persist?: (keyof State)[];
     computed?: ComputedStateDefinition<State, ComputedState>;
     serialize?: (state: Partial<State>) => Partial<State>;
-}): Constructor<State> & Constructor<ComputedState> & Constructor<Service<State, ComputedState, Partial<State>>> {
-    return class extends Service<State, ComputedState> {
+}): Constructor<UnrefServiceState<State>> &
+    Constructor<ComputedState> &
+    Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>> {
+    return class extends Service<UnrefServiceState<State>, ComputedState> {
 
         public static persist = (options.persist as string[]) ?? [];
 
@@ -37,21 +43,21 @@ export function defineServiceState<
             return options.name ?? null;
         }
 
-        protected getInitialState(): State {
+        protected getInitialState(): UnrefServiceState<State> {
             return options.initialState;
         }
 
-        protected getComputedStateDefinition(): ComputedStateDefinition<State, ComputedState> {
-            return options.computed ?? ({} as ComputedStateDefinition<State, ComputedState>);
+        protected getComputedStateDefinition(): ComputedStateDefinition<UnrefServiceState<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<UnrefServiceState<State>, ComputedState>;
         }
 
         protected serializePersistedState(state: Partial<State>): Partial<State> {
             return options.serialize?.(state) ?? state;
         }
     
-    } as unknown as Constructor<State> &
+    } as unknown as Constructor<UnrefServiceState<State>> &
         Constructor<ComputedState> &
-        Constructor<Service<State, ComputedState, Partial<State>>>;
+        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
 }
 
 export default class Service<
@@ -162,7 +168,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,
@@ -191,14 +201,14 @@ export default class Service<
     }
 
     protected async frameworkBoot(): Promise<void> {
-        this.restorePersistedState();
+        this.initializePersistedState();
     }
 
     protected async boot(): Promise<void> {
-        // Override.
+        // 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

@@ -50,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,10 +1,11 @@
-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';
 
 import Events from '@/services/Events';
 import type { SnackbarAction, SnackbarColor } from '@/components/headless/snackbars';
+import type { AGAlertModalProps, AGConfirmModalProps, AGLoadingModalProps, AGPromptModalProps } from '@/components';
 
 import Service from './UI.state';
 import type { Modal, ModalComponent, Snackbar } from './UI.state';
@@ -24,11 +25,26 @@ export const UIComponents = {
     ConfirmModal: 'confirm-modal',
     ErrorReportModal: 'error-report-modal',
     LoadingModal: 'loading-modal',
+    PromptModal: 'prompt-modal',
     Snackbar: 'snackbar',
+    StartupCrash: 'startup-crash',
 } as const;
 
 export type UIComponent = ObjectValues<typeof UIComponents>;
 
+export interface ConfirmOptions {
+    acceptText?: string;
+    cancelText?: string;
+}
+
+export interface PromptOptions {
+    label?: string;
+    defaultValue?: string;
+    placeholder?: string;
+    acceptText?: string;
+    cancelText?: string;
+}
+
 export interface ShowSnackbarOptions {
     component?: Component;
     color?: SnackbarColor;
@@ -47,36 +63,104 @@ 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 };
-        const modal = await this.openModal<ModalComponent<{ message: string }, boolean>>(
+    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<AGConfirmModalProps, boolean>>(
             this.requireComponent(UIComponents.ConfirmModal),
-            options,
+            getProperties(),
         );
         const result = await modal.beforeClose;
 
         return result ?? false;
     }
 
+    public async prompt(message: string, options?: PromptOptions): Promise<string | null>;
+    public async prompt(title: string, message: string, options?: PromptOptions): Promise<string | null>;
+    public async prompt(
+        messageOrTitle: string,
+        messageOrOptions?: string | PromptOptions,
+        options?: PromptOptions,
+    ): Promise<string | null> {
+        const getProperties = (): AGPromptModalProps => {
+            if (typeof messageOrOptions !== 'string') {
+                return {
+                    message: messageOrTitle,
+                    ...(messageOrOptions ?? {}),
+                };
+            }
+
+            return {
+                title: messageOrTitle,
+                message: messageOrOptions,
+                ...(options ?? {}),
+            };
+        };
+
+        const modal = await this.openModal<ModalComponent<AGPromptModalProps, string | null>>(
+            this.requireComponent(UIComponents.PromptModal),
+            getProperties(),
+        );
+        const result = await modal.beforeClose;
+
+        return result ?? null;
+    }
+
     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 {};
+            }
 
-        const message = typeof messageOrOperation === 'string' ? messageOrOperation : undefined;
-        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), { message });
-        const result = await operation;
+            return { message: messageOrOperation };
+        };
+
+        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 {
@@ -138,6 +222,7 @@ export class UIService extends Service {
 
     protected async boot(): Promise<void> {
         this.watchModalEvents();
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -165,6 +250,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

@@ -8,13 +8,16 @@ import AGAlertModal from '../components/modals/AGAlertModal.vue';
 import AGConfirmModal from '../components/modals/AGConfirmModal.vue';
 import AGErrorReportModal from '../components/modals/AGErrorReportModal.vue';
 import AGLoadingModal from '../components/modals/AGLoadingModal.vue';
+import AGPromptModal from '../components/modals/AGPromptModal.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({
@@ -24,7 +27,9 @@ export default definePlugin({
             [UIComponents.ConfirmModal]: AGConfirmModal,
             [UIComponents.ErrorReportModal]: AGErrorReportModal,
             [UIComponents.LoadingModal]: AGLoadingModal,
+            [UIComponents.PromptModal]: AGPromptModal,
             [UIComponents.Snackbar]: AGSnackbar,
+            [UIComponents.StartupCrash]: AGStartupCrash,
         };
 
         Object.entries({
@@ -37,7 +42,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';

package/src/utils/tailwindcss.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it } from 'vitest';
+
+import { removeInteractiveClasses } from './tailwindcss';
+
+describe('TailwindCSS utils', () => {
+
+    it('Removes interactive classes', () => {
+        const cases: [string, string][] = [
+            ['text-red hover:text-green', 'text-red'],
+            ['text-red hover:text-green text-lg', 'text-red text-lg'],
+            [
+                `
+                    text-red text-lg
+                    focus:text-yellow
+                    hover:focus:text-black
+                `,
+                'text-red text-lg',
+            ],
+        ];
+
+        cases.forEach(([original, expected]) => {
+            expect(removeInteractiveClasses(original)).toEqual(expected);
+        });
+    });
+
+});

package/src/utils/tailwindcss.ts

@@ -0,0 +1,7 @@
+export function removeInteractiveClasses(classes: string): string {
+    return classes
+        .split(/\s+/)
+        .filter((className) => !/^(hover|focus|focus-visible):/.test(className))
+        .join(' ')
+        .trim();
+}

package/src/utils/vue.ts

@@ -1,5 +1,5 @@
 import { fail } from '@noeldemartin/utils';
-import { inject, reactive, ref } from 'vue';
+import { computed, inject, reactive, ref, watch } from 'vue';
 import type { Directive, InjectionKey, PropType, Ref, UnwrapNestedRefs } from 'vue';
 
 type BaseProp<T> = {
@@ -30,6 +30,15 @@ export function componentRef<T>(): Ref<UnwrapNestedRefs<T> | undefined> {
     return ref<UnwrapNestedRefs<T>>();
 }
 
+export function computedAsync<T>(getter: () => Promise<T>): Ref<T | undefined> {
+    const result = ref<T>();
+    const asyncValue = computed(getter);
+
+    watch(asyncValue, async () => (result.value = await asyncValue.value), { immediate: true });
+
+    return result;
+}
+
 export function defineDirective(directive: Directive): Directive {
     return directive;
 }

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
-        "types": ["unplugin-icons/types/vue3"],
+        "types": ["unplugin-icons/types/vue3", "@aerogel/vite/dist/virtual"],
         "baseUrl": ".",
         "paths": {
             "@/*": ["./src/*"]

package/.eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-    extends: ['@noeldemartin/eslint-config-vue'],
-};

package/dist/virtual.d.ts

@@ -1,11 +0,0 @@
-declare module 'virtual:aerogel' {
-    interface AerogelBuild {
-        environment: 'production' | 'development' | 'testing';
-        basePath?: string;
-        sourceUrl?: string;
-    }
-
-    const build: AerogelBuild;
-
-    export default build;
-}

package/src/components/basic/index.ts

@@ -1,5 +0,0 @@
-import AGErrorMessage from './AGErrorMessage.vue';
-import AGLink from './AGLink.vue';
-import AGMarkdown from './AGMarkdown.vue';
-
-export { AGErrorMessage, AGLink, AGMarkdown };

package/src/types/virtual.d.ts

@@ -1,11 +0,0 @@
-declare module 'virtual:aerogel' {
-    interface AerogelBuild {
-        environment: 'production' | 'development' | 'testing';
-        basePath?: string;
-        sourceUrl?: string;
-    }
-
-    const build: AerogelBuild;
-
-    export default build;
-}