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

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> {
@@ -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

@@ -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 {

package/src/main.histoire.ts

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

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,8 +7,8 @@ export default defineServiceState({
     name: 'app',
     initialState: {
         plugins: {} as Record<string, Plugin>,
-        environment: Build.environment,
-        sourceUrl: Build.sourceUrl,
+        environment: Aerogel.environment,
+        sourceUrl: Aerogel.sourceUrl,
         isMounted: false,
     },
     computed: {

package/src/services/App.ts

@@ -1,4 +1,4 @@
-import { facade } from '@noeldemartin/utils';
+import { facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
 
 import Events from '@/services/Events';
 import type { Plugin } from '@/plugins';
@@ -7,6 +7,15 @@ import Service from './App.state';
 
 export class AppService extends Service {
 
+    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;
     }

package/src/services/Service.ts

@@ -162,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,
@@ -191,14 +195,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,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 modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
 
-        const message = typeof messageOrOperation === 'string' ? messageOrOperation : undefined;
-        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), { message });
-        const result = await operation;
+        try {
+            operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
 
-        await this.closeModal(modal.id);
+            const [result] = await Promise.all([operation, after({ seconds: 1 })]);
 
-        return result;
+            return result;
+        } finally {
+            await this.closeModal(modal.id);
+        }
     }
 
     public showSnackbar(message: string, options: ShowSnackbarOptions = {}): void {
@@ -138,6 +182,7 @@ export class UIService extends Service {
 
     protected async boot(): Promise<void> {
         this.watchModalEvents();
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -165,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';

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,9 +1,9 @@
 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> = {
-    type: PropType<T>;
+    type?: PropType<T>;
     validator?(value: unknown): boolean;
 };
 
@@ -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;
 }
@@ -64,7 +73,7 @@ export function injectOrFail<T>(key: InjectionKey<T> | string, errorMessage?: st
     return inject(key) ?? fail(errorMessage ?? `Could not resolve '${key}' injection key`);
 }
 
-export function mixedProp<T>(type: PropType<T>): OptionalProp<T | null> {
+export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null> {
     return {
         type,
         default: null,
@@ -108,7 +117,7 @@ export function requiredEnumProp<Enum extends Record<string, unknown>>(
     };
 }
 
-export function requiredMixedProp<T>(type: PropType<T>): RequiredProp<T> {
+export function requiredMixedProp<T>(type?: PropType<T>): RequiredProp<T> {
     return {
         type,
         required: true,

package/tailwind.config.js

@@ -0,0 +1,4 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    content: ['./src/**/*.{vue,ts}'],
+};

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