@aerogel/core 0.0.0-next.c8f032a868370824898e171969aec1bb6827688e → 0.0.0-next.d547095ca85c86c1e41f5c7fa170d0ba856c3f4d

package/src/testing/index.ts

@@ -0,0 +1,25 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
+import { definePlugin } from '@/plugins';
+
+export interface AerogelTestingRuntime {
+    on: (typeof Events)['on'];
+}
+
+export default definePlugin({
+    async install() {
+        if (import.meta.env.MODE !== 'testing') {
+            return;
+        }
+
+        globalThis.testingRuntime = {
+            on: ((...args: GetClosureArgs<(typeof Events)['on']>) => Events.on(...args)) as (typeof Events)['on'],
+        };
+    },
+});
+
+declare global {
+    // eslint-disable-next-line no-var
+    var testingRuntime: AerogelTestingRuntime | undefined;
+}

package/src/ui/UI.state.ts

@@ -17,6 +17,16 @@ export interface ModalComponent<
     Result = unknown
 > {}
 
+export interface Snackbar {
+    id: string;
+    component: Component;
+    properties: Record<string, unknown>;
+}
+
 export default defineServiceState({
-    initialState: { modals: [] as Modal[] },
+    name: 'ui',
+    initialState: {
+        modals: [] as Modal[],
+        snackbars: [] as Snackbar[],
+    },
 });

package/src/ui/UI.ts

@@ -1,12 +1,14 @@
-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 } from './UI.state';
+import type { Modal, ModalComponent, Snackbar } from './UI.state';
 
 interface ModalCallbacks<T = unknown> {
     willClose(result: T | undefined): void;
@@ -21,36 +23,165 @@ type ModalResult<TComponent> = TComponent extends ModalComponent<Record<string,
 export const UIComponents = {
     AlertModal: 'alert-modal',
     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;
+    actions?: SnackbarAction[];
+}
+
 export class UIService extends Service {
 
     private modalCallbacks: Record<string, Partial<ModalCallbacks>> = {};
     private components: Partial<Record<UIComponent, Component>> = {};
 
+    public requireComponent(name: UIComponent): Component {
+        return this.components[name] ?? fail(`UI Component '${name}' is not defined!`);
+    }
+
     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 };
+            }
+
+            return {
+                title: messageOrTitle,
+                message,
+            };
+        };
 
-        this.openModal(this.requireComponent(UIComponents.AlertModal), options);
+        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> {
+        const getProperties = (): AGLoadingModalProps => {
+            if (typeof messageOrOperation !== 'string') {
+                return {};
+            }
+
+            return { message: messageOrOperation };
+        };
+
+        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
+
+        try {
+            operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
+
+            const [result] = await Promise.all([operation, after({ seconds: 1 })]);
+
+            return result;
+        } finally {
+            await this.closeModal(modal.id);
+        }
+    }
+
+    public showSnackbar(message: string, options: ShowSnackbarOptions = {}): void {
+        const snackbar: Snackbar = {
+            id: uuid(),
+            properties: { message, ...options },
+            component: markRaw(options.component ?? this.requireComponent(UIComponents.Snackbar)),
+        };
+
+        this.setState('snackbars', this.snackbars.concat(snackbar));
+
+        setTimeout(() => this.hideSnackbar(snackbar.id), 5000);
+    }
+
+    public hideSnackbar(id: string): void {
+        this.setState(
+            'snackbars',
+            this.snackbars.filter((snackbar) => snackbar.id !== id),
+        );
+    }
+
     public registerComponent(name: UIComponent, component: Component): void {
         this.components[name] = component;
     }
@@ -90,13 +221,8 @@ export class UIService extends Service {
     }
 
     protected async boot(): Promise<void> {
-        await super.boot();
-
         this.watchModalEvents();
-    }
-
-    private requireComponent(name: UIComponent): Component {
-        return this.components[name] ?? fail(`UI Component '${name}' is not defined!`);
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -109,7 +235,10 @@ export class UIService extends Service {
         });
 
         Events.on('modal-closed', async ({ modal, result }) => {
-            this.setState({ modals: this.modals.filter((m) => m.id !== modal.id) });
+            this.setState(
+                'modals',
+                this.modals.filter((m) => m.id !== modal.id),
+            );
 
             this.modalCallbacks[modal.id]?.closed?.(result);
 
@@ -121,16 +250,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

@@ -6,12 +6,18 @@ import { definePlugin } from '@/plugins';
 import UI, { UIComponents } from './UI';
 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({
@@ -19,6 +25,11 @@ export default definePlugin({
         const defaultComponents = {
             [UIComponents.AlertModal]: AGAlertModal,
             [UIComponents.ConfirmModal]: AGConfirmModal,
+            [UIComponents.ErrorReportModal]: AGErrorReportModal,
+            [UIComponents.LoadingModal]: AGLoadingModal,
+            [UIComponents.PromptModal]: AGPromptModal,
+            [UIComponents.Snackbar]: AGSnackbar,
+            [UIComponents.StartupCrash]: AGStartupCrash,
         };
 
         Object.entries({
@@ -31,11 +42,11 @@ export default definePlugin({
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         components?: Partial<Record<UIComponent, Component>>;
     }
 }
 
 declare module '@/services' {
-    interface Services extends UIServices {}
+    export interface Services extends UIServices {}
 }

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/composition/forms.ts

@@ -0,0 +1,11 @@
+import { objectWithout } from '@noeldemartin/utils';
+import { computed, useAttrs } from 'vue';
+import type { ComputedRef } from 'vue';
+
+export function useInputAttrs(): [ComputedRef<{}>, ComputedRef<unknown>] {
+    const attrs = useAttrs();
+    const className = computed(() => attrs.class);
+    const inputAttrs = computed(() => objectWithout(attrs, 'class'));
+
+    return [inputAttrs, className];
+}

package/src/utils/index.ts

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

package/src/utils/markdown.ts

@@ -1,8 +1,17 @@
+import { tap } from '@noeldemartin/utils';
 import DOMPurify from 'dompurify';
-import { marked } from 'marked';
+import { Renderer, marked } from 'marked';
+
+function makeRenderer(): Renderer {
+    return tap(new Renderer(), (renderer) => {
+        renderer.link = function(href, title, text) {
+            return Renderer.prototype.link.apply(this, [href, title, text]).replace('<a', '<a target="_blank"');
+        };
+    });
+}
 
 export function renderMarkdown(markdown: string): string {
-    return safeHtml(marked(markdown, { mangle: false, headerIds: false }));
+    return safeHtml(marked(markdown, { mangle: false, headerIds: false, renderer: makeRenderer() }));
 }
 
 export function safeHtml(html: string): string {

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,15 +1,17 @@
 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;
 };
 
 type RequiredProp<T> = BaseProp<T> & { required: true };
 type OptionalProp<T> = BaseProp<T> & { default: T | (() => T) | null };
 
+export type ComponentProps = Record<string, unknown>;
+
 export function arrayProp<T>(defaultValue?: () => T[]): OptionalProp<T[]> {
     return {
         type: Array as PropType<T[]>,
@@ -28,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;
 }
@@ -62,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,
@@ -106,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,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
+        "types": ["unplugin-icons/types/vue3", "@aerogel/vite/dist/virtual"],
         "baseUrl": ".",
         "paths": {
             "@/*": ["./src/*"]

package/vite.config.ts

@@ -1,10 +1,11 @@
 import Aerogel from '@aerogel/vite';
+import Icons from 'unplugin-icons/vite';
 import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
     test: { clearMocks: true },
-    plugins: [Aerogel()],
+    plugins: [Aerogel(), Icons()],
     resolve: {
         alias: {
             '@': resolve(__dirname, './src'),

package/.eslintrc.js

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

package/src/components/basic/AGMarkdown.vue

@@ -1,35 +0,0 @@
-<template>
-    <root />
-</template>
-
-<script setup lang="ts">
-import { computed, h } from 'vue';
-
-import { renderMarkdown } from '@/utils/markdown';
-import { booleanProp, stringProp } from '@/utils/vue';
-import { translate } from '@/lang';
-
-const props = defineProps({
-    as: stringProp('div'),
-    langKey: stringProp(),
-    text: stringProp(),
-    inline: booleanProp(),
-    raw: booleanProp(),
-});
-
-const markdown = computed(() => props.text ?? (props.langKey && translate(props.langKey)));
-const html = computed(() => {
-    if (!markdown.value) {
-        return null;
-    }
-
-    let html = renderMarkdown(markdown.value);
-
-    if (props.inline) {
-        html = html.replace('<p>', '<span>').replace('</p>', '</span>');
-    }
-
-    return html;
-});
-const root = () => h(props.as, { class: props.raw ? '' : 'prose', innerHTML: html.value });
-</script>

package/src/components/basic/index.ts

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

package/src/globals.ts

@@ -1,6 +0,0 @@
-export {};
-
-declare global {
-    export const __AG_BASE_PATH: string | undefined;
-    export const __AG_ENV: 'production' | 'development' | 'testing';
-}