@aerogel/core 0.0.0-next.b58141fee5d2fe7d25debdbca6b1d2bf1c13e48e → 0.0.0-next.bde642c4a8096c5fc3d5e676c2115da23f4bf1d8

package/src/ui/UI.ts

@@ -1,10 +1,12 @@
-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 { Color } from '@/components/constants';
 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 +26,31 @@ 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;
+    acceptColor?: Color;
+    cancelText?: string;
+    cancelColor?: Color;
+}
+
+export interface PromptOptions {
+    label?: string;
+    defaultValue?: string;
+    placeholder?: string;
+    acceptText?: string;
+    acceptColor?: Color;
+    cancelText?: string;
+    cancelColor?: Color;
+    trim?: boolean;
+}
+
 export interface ShowSnackbarOptions {
     component?: Component;
     color?: SnackbarColor;
@@ -47,43 +69,113 @@ 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 trim = options?.trim ?? true;
+        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 rawResult = await modal.beforeClose;
+        const result = trim && typeof rawResult === 'string' ? rawResult?.trim() : rawResult;
+
+        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 {};
+            }
+
+            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 {
         const snackbar: Snackbar = {
             id: uuid(),
             properties: { message, ...options },
-            component: options.component ?? markRaw(this.requireComponent(UIComponents.Snackbar)),
+            component: markRaw(options.component ?? this.requireComponent(UIComponents.Snackbar)),
         };
 
         this.setState('snackbars', this.snackbars.concat(snackbar));
@@ -138,6 +230,7 @@ export class UIService extends Service {
 
     protected async boot(): Promise<void> {
         this.watchModalEvents();
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -165,16 +258,36 @@ 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());
+export default facade(UIService);
 
 declare module '@/services/Events' {
     export interface EventsPayload {
-        'modal-will-close': { modal: Modal; result?: unknown };
-        'modal-closed': { modal: Modal; result?: unknown };
         'close-modal': { id: string; result?: unknown };
         'hide-modal': { id: string };
+        'hide-overlays-backdrop': void;
+        'modal-closed': { modal: Modal; result?: unknown };
+        'modal-will-close': { modal: Modal; result?: unknown };
         'show-modal': { id: string };
+        'show-overlays-backdrop': void;
     }
 }

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,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,10 +73,12 @@ 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>;
+export function mixedProp<T>(type: PropType<T>, defaultValue: T): OptionalProp<T>;
+export function mixedProp<T>(type?: PropType<T>, defaultValue?: T): OptionalProp<T | null> {
     return {
         type,
-        default: null,
+        default: defaultValue ?? null,
     };
 }
 
@@ -108,7 +119,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/vite.config.ts

@@ -4,7 +4,10 @@ import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
-    test: { clearMocks: true },
+    test: {
+        clearMocks: true,
+        setupFiles: ['./src/testing/setup.ts'],
+    },
     plugins: [Aerogel(), Icons()],
     resolve: {
         alias: {

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