@aerogel/core 0.0.0-next.c2e6acc000e97a1020c2e232678563c53884dd0e → 0.0.0-next.c3236837f7f8fc319a4a56022accb32757b3db89

package/src/ui/UI.ts

@@ -1,42 +1,55 @@
 import { after, facade, fail, isDevelopment, required, uuid } from '@noeldemartin/utils';
-import { markRaw, nextTick } from 'vue';
+import { markRaw, nextTick, unref } from 'vue';
+import type { ComponentExposed, ComponentProps } from 'vue-component-type-helpers';
 import type { Component } from 'vue';
-import type { ObjectValues } from '@noeldemartin/utils';
+import type { ClosureArgs } from '@noeldemartin/utils';
 
 import App from '@aerogel/core/services/App';
 import Events from '@aerogel/core/services/Events';
+import type {
+    ConfirmModalCheckboxes,
+    ConfirmModalExpose,
+    ConfirmModalProps,
+} from '@aerogel/core/components/contracts/ConfirmModal';
+import type {
+    ErrorReportModalExpose,
+    ErrorReportModalProps,
+} from '@aerogel/core/components/contracts/ErrorReportModal';
 import type { AcceptRefs } from '@aerogel/core/utils';
-import type { AlertModalProps } from '@aerogel/core/components/contracts/AlertModal';
+import type { AlertModalExpose, AlertModalProps } from '@aerogel/core/components/contracts/AlertModal';
 import type { ButtonVariant } from '@aerogel/core/components/contracts/Button';
-import type { ConfirmModalCheckboxes, ConfirmModalProps } from '@aerogel/core/components/contracts/ConfirmModal';
-import type { LoadingModalProps } from '@aerogel/core/components/contracts/LoadingModal';
-import type { PromptModalProps } from '@aerogel/core/components/contracts/PromptModal';
-import type { SnackbarAction, SnackbarColor } from '@aerogel/core/components/headless/snackbars';
+import type { LoadingModalExpose, LoadingModalProps } from '@aerogel/core/components/contracts/LoadingModal';
+import type { PromptModalExpose, PromptModalProps } from '@aerogel/core/components/contracts/PromptModal';
+import type { ToastAction, ToastExpose, ToastProps, ToastVariant } from '@aerogel/core/components/contracts/Toast';
 
 import Service from './UI.state';
 import { MOBILE_BREAKPOINT, getCurrentLayout } from './utils';
-import type { ModalComponent, Snackbar, UIModal } from './UI.state';
+import type { UIModal, UIToast } from './UI.state';
 
 interface ModalCallbacks<T = unknown> {
     willClose(result: T | undefined): void;
-    closed(result: T | undefined): void;
+    hasClosed(result: T | undefined): void;
 }
 
-type ModalProperties<TComponent> = TComponent extends ModalComponent<infer TProperties, unknown> ? TProperties : never;
-type ModalResult<TComponent> =
-    TComponent extends ModalComponent<Record<string, unknown>, infer TResult> ? TResult : never;
-
-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 ModalResult<T> = ModalExposeResult<ComponentExposed<T>>;
+export type ModalExposeResult<T> = T extends { close(result?: infer Result): Promise<void> } ? Result : unknown;
+export type UIComponent<Props = {}, Exposed = {}> = { new (...args: ClosureArgs): Exposed & { $props: Props } };
+
+export interface UIComponents {
+    'alert-modal': UIComponent<AlertModalProps, AlertModalExpose>;
+    'confirm-modal': UIComponent<ConfirmModalProps, ConfirmModalExpose>;
+    'error-report-modal': UIComponent<ErrorReportModalProps, ErrorReportModalExpose>;
+    'loading-modal': UIComponent<LoadingModalProps, LoadingModalExpose>;
+    'prompt-modal': UIComponent<PromptModalProps, PromptModalExpose>;
+    'router-link': UIComponent;
+    'startup-crash': UIComponent;
+    toast: UIComponent<ToastProps, ToastExpose>;
+}
 
-export type UIComponent = ObjectValues<typeof UIComponents>;
+export interface UIModalContext {
+    modal: UIModal;
+    childIndex?: number;
+}
 
 export type ConfirmOptions = AcceptRefs<{
     acceptText?: string;
@@ -51,6 +64,7 @@ export type LoadingOptions = AcceptRefs<{
     title?: string;
     message?: string;
     progress?: number;
+    delay?: number;
 }>;
 
 export interface ConfirmOptionsWithCheckboxes<T extends ConfirmModalCheckboxes = ConfirmModalCheckboxes>
@@ -69,19 +83,27 @@ export type PromptOptions = AcceptRefs<{
     trim?: boolean;
 }>;
 
-export interface ShowSnackbarOptions {
+export interface ToastOptions {
     component?: Component;
-    color?: SnackbarColor;
-    actions?: SnackbarAction[];
+    variant?: ToastVariant;
+    actions?: ToastAction[];
 }
 
 export class UIService extends Service {
 
     private modalCallbacks: Record<string, Partial<ModalCallbacks>> = {};
-    private components: Partial<Record<UIComponent, Component>> = {};
+    private components: Partial<UIComponents> = {};
 
-    public requireComponent(name: UIComponent): Component {
-        return this.components[name] ?? fail(`UI Component '${name}' is not defined!`);
+    public registerComponent<T extends keyof UIComponents>(name: T, component: UIComponents[T]): void {
+        this.components[name] = component;
+    }
+
+    public resolveComponent<T extends keyof UIComponents>(name: T): UIComponents[T] | null {
+        return this.components[name] ?? null;
+    }
+
+    public requireComponent<T extends keyof UIComponents>(name: T): UIComponents[T] {
+        return this.resolveComponent(name) ?? fail(`UI Component '${name}' is not defined!`);
     }
 
     public alert(message: string): void;
@@ -98,10 +120,7 @@ export class UIService extends Service {
             };
         };
 
-        this.openModal<ModalComponent<AlertModalProps>>(
-            this.requireComponent(UIComponents.AlertModal),
-            getProperties(),
-        );
+        this.modal(this.requireComponent('alert-modal'), getProperties());
     }
 
     /* eslint-disable max-len */
@@ -133,18 +152,8 @@ export class UIService extends Service {
             };
         };
 
-        type ConfirmModalComponent = ModalComponent<
-            AcceptRefs<ConfirmModalProps>,
-            boolean | [boolean, Record<string, boolean>]
-        >;
-
         const properties = getProperties();
-        const modal = await this.openModal<ConfirmModalComponent>(
-            this.requireComponent(UIComponents.ConfirmModal),
-            properties,
-        );
-        const result = await modal.beforeClose;
-
+        const result = await this.modalForm(this.requireComponent('confirm-modal'), properties);
         const confirmed = typeof result === 'object' ? result[0] : (result ?? false);
         const checkboxes =
             typeof result === 'object'
@@ -196,11 +205,7 @@ export class UIService extends Service {
             } as PromptModalProps;
         };
 
-        const modal = await this.openModal<ModalComponent<PromptModalProps, string | null>>(
-            this.requireComponent(UIComponents.PromptModal),
-            getProperties(),
-        );
-        const rawResult = await modal.beforeClose;
+        const rawResult = await this.modalForm(this.requireComponent('prompt-modal'), getProperties());
         const result = trim && typeof rawResult === 'string' ? rawResult?.trim() : rawResult;
 
         return result ?? null;
@@ -214,7 +219,11 @@ export class UIService extends Service {
         operation?: Promise<T> | (() => T),
     ): Promise<T> {
         const processOperation = (o: Promise<T> | (() => T)) => (typeof o === 'function' ? Promise.resolve(o()) : o);
-        const processArgs = (): { operationPromise: Promise<T>; props?: AcceptRefs<LoadingModalProps> } => {
+        const processArgs = (): {
+            operationPromise: Promise<T>;
+            props?: AcceptRefs<LoadingModalProps>;
+            delay?: number;
+        } => {
             if (typeof operationOrMessageOrOptions === 'string') {
                 return {
                     props: { message: operationOrMessageOrOptions },
@@ -226,14 +235,25 @@ export class UIService extends Service {
                 return { operationPromise: processOperation(operationOrMessageOrOptions) };
             }
 
+            const { delay, ...props } = operationOrMessageOrOptions;
+
             return {
-                props: operationOrMessageOrOptions,
+                props,
+                delay: unref(delay),
                 operationPromise: processOperation(operation as Promise<T> | (() => T)),
             };
         };
 
-        const { operationPromise, props } = processArgs();
-        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), props);
+        let delayed = false;
+        const { operationPromise, props, delay } = processArgs();
+
+        delay && (await Promise.race([after({ ms: delay }).then(() => (delayed = true)), operationPromise]));
+
+        if (delay && !delayed) {
+            return operationPromise;
+        }
+
+        const modal = await this.modal(this.requireComponent('loading-modal'), props);
 
         try {
             const result = await operationPromise;
@@ -246,43 +266,34 @@ export class UIService extends Service {
         }
     }
 
-    public showSnackbar(message: string, options: ShowSnackbarOptions = {}): void {
-        const snackbar: Snackbar = {
+    public toast(message: string, options: ToastOptions = {}): void {
+        const { component, ...otherOptions } = options;
+        const toast: UIToast = {
             id: uuid(),
-            properties: { message, ...options },
-            component: markRaw(options.component ?? this.requireComponent(UIComponents.Snackbar)),
+            properties: { message, ...otherOptions },
+            component: markRaw(component ?? this.requireComponent('toast')),
         };
 
-        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),
-        );
+        this.setState('toasts', this.toasts.concat(toast));
     }
 
-    public registerComponent(name: UIComponent, component: Component): void {
-        this.components[name] = component;
-    }
+    public modal<T extends Component>(
+        ...args: {} extends ComponentProps<T>
+            ? [component: T, props?: AcceptRefs<ComponentProps<T>>]
+            : [component: T, props: AcceptRefs<ComponentProps<T>>]
+    ): Promise<UIModal<ModalResult<T>>>;
 
-    public async openModal<TModalComponent extends ModalComponent>(
-        component: TModalComponent,
-        properties?: ModalProperties<TModalComponent>,
-    ): Promise<UIModal<ModalResult<TModalComponent>>> {
+    public async modal<T extends Component>(component: T, props?: ComponentProps<T>): Promise<UIModal<ModalResult<T>>> {
         const id = uuid();
-        const callbacks: Partial<ModalCallbacks<ModalResult<TModalComponent>>> = {};
-        const modal: UIModal<ModalResult<TModalComponent>> = {
+        const callbacks: Partial<ModalCallbacks<ModalResult<T>>> = {};
+        const modal: UIModal<ModalResult<T>> = {
             id,
-            properties: properties ?? {},
+            closing: false,
+            properties: props ?? {},
             component: markRaw(component),
             beforeClose: new Promise((resolve) => (callbacks.willClose = resolve)),
-            afterClose: new Promise((resolve) => (callbacks.closed = resolve)),
+            afterClose: new Promise((resolve) => (callbacks.hasClosed = resolve)),
         };
-        const activeModal = this.modals.at(-1);
         const modals = this.modals.concat(modal);
 
         this.modalCallbacks[modal.id] = callbacks;
@@ -290,15 +301,26 @@ export class UIService extends Service {
         this.setState({ modals });
 
         await nextTick();
-        await (activeModal && Events.emit('hide-modal', { id: activeModal.id }));
-        await Promise.all([
-            activeModal || Events.emit('show-overlays-backdrop'),
-            Events.emit('show-modal', { id: modal.id }),
-        ]);
 
         return modal;
     }
 
+    public modalForm<T extends Component>(
+        ...args: {} extends ComponentProps<T>
+            ? [component: T, props?: AcceptRefs<ComponentProps<T>>]
+            : [component: T, props: AcceptRefs<ComponentProps<T>>]
+    ): Promise<ModalResult<T> | undefined>;
+
+    public async modalForm<T extends Component>(
+        component: T,
+        props?: ComponentProps<T>,
+    ): Promise<ModalResult<T> | undefined> {
+        const modal = await this.modal<T>(component, props as ComponentProps<T>);
+        const result = await modal.beforeClose;
+
+        return result;
+    }
+
     public async closeModal(id: string, result?: unknown): Promise<void> {
         if (!App.isMounted()) {
             await this.removeModal(id, result);
@@ -327,25 +349,23 @@ export class UIService extends Service {
             this.modals.filter((m) => m.id !== id),
         );
 
-        this.modalCallbacks[id]?.closed?.(result);
+        this.modalCallbacks[id]?.hasClosed?.(result);
 
         delete this.modalCallbacks[id];
-
-        const activeModal = this.modals.at(-1);
-
-        await (activeModal && Events.emit('show-modal', { id: activeModal.id }));
     }
 
     private watchModalEvents(): void {
-        Events.on('modal-will-close', ({ modal, result }) => {
-            this.modalCallbacks[modal.id]?.willClose?.(result);
+        Events.on('modal-will-close', ({ modal: { id }, result }) => {
+            const modal = this.modals.find((_modal) => id === _modal.id);
 
-            if (this.modals.length === 1) {
-                Events.emit('hide-overlays-backdrop');
+            if (modal) {
+                modal.closing = true;
             }
+
+            this.modalCallbacks[id]?.willClose?.(result);
         });
 
-        Events.on('modal-closed', async ({ modal: { id }, result }) => {
+        Events.on('modal-has-closed', async ({ modal: { id }, result }) => {
             await this.removeModal(id, result);
         });
     }
@@ -389,11 +409,7 @@ export default facade(UIService);
 declare module '@aerogel/core/services/Events' {
     export interface EventsPayload {
         'close-modal': { id: string; result?: unknown };
-        'hide-modal': { id: string };
-        'hide-overlays-backdrop': void;
-        'modal-closed': { modal: UIModal; result?: unknown };
         'modal-will-close': { modal: UIModal; result?: unknown };
-        'show-modal': { id: string };
-        'show-overlays-backdrop': void;
+        'modal-has-closed': { modal: UIModal; result?: unknown };
     }
 }

package/src/ui/index.ts

@@ -1,17 +1,16 @@
-import type { Component } from 'vue';
-
-import AGSnackbar from '@aerogel/core/components/snackbars/AGSnackbar.vue';
-import AGStartupCrash from '@aerogel/core/components/lib/AGStartupCrash.vue';
 import AlertModal from '@aerogel/core/components/ui/AlertModal.vue';
 import ConfirmModal from '@aerogel/core/components/ui/ConfirmModal.vue';
 import ErrorReportModal from '@aerogel/core/components/ui/ErrorReportModal.vue';
 import LoadingModal from '@aerogel/core/components/ui/LoadingModal.vue';
 import PromptModal from '@aerogel/core/components/ui/PromptModal.vue';
+import StartupCrash from '@aerogel/core/components/ui/StartupCrash.vue';
+import Toast from '@aerogel/core/components/ui/Toast.vue';
 import { bootServices } from '@aerogel/core/services';
 import { definePlugin } from '@aerogel/core/plugins';
 
-import UI, { UIComponents } from './UI';
-import type { UIComponent } from './UI';
+import UI from './UI';
+import type { UIComponents } from './UI';
+import type { Component } from 'vue';
 
 const services = { $ui: UI };
 
@@ -23,20 +22,20 @@ export type UIServices = typeof services;
 
 export default definePlugin({
     async install(app, options) {
-        const defaultComponents = {
-            [UIComponents.AlertModal]: AlertModal,
-            [UIComponents.ConfirmModal]: ConfirmModal,
-            [UIComponents.ErrorReportModal]: ErrorReportModal,
-            [UIComponents.LoadingModal]: LoadingModal,
-            [UIComponents.PromptModal]: PromptModal,
-            [UIComponents.Snackbar]: AGSnackbar,
-            [UIComponents.StartupCrash]: AGStartupCrash,
+        const components: Partial<Record<keyof UIComponents, Component>> = {
+            'alert-modal': AlertModal,
+            'confirm-modal': ConfirmModal,
+            'error-report-modal': ErrorReportModal,
+            'loading-modal': LoadingModal,
+            'prompt-modal': PromptModal,
+            'startup-crash': StartupCrash,
+            'toast': Toast,
+            ...options.components,
         };
 
-        Object.entries({
-            ...defaultComponents,
-            ...options.components,
-        }).forEach(([name, component]) => UI.registerComponent(name as UIComponent, component));
+        for (const [name, component] of Object.entries(components)) {
+            UI.registerComponent(name as keyof UIComponents, component as UIComponents[keyof UIComponents]);
+        }
 
         await bootServices(app, services);
     },
@@ -44,7 +43,7 @@ export default definePlugin({
 
 declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
-        components?: Partial<Record<UIComponent, Component>>;
+        components?: Partial<Partial<UIComponents>>;
     }
 }
 

package/src/utils/classes.ts

@@ -0,0 +1,41 @@
+import clsx from 'clsx';
+import { unref } from 'vue';
+import { cva } from 'class-variance-authority';
+import { twMerge } from 'tailwind-merge';
+import type { ClassValue } from 'clsx';
+import type { PropType } from 'vue';
+import type { GetClosureArgs, GetClosureResult } from '@noeldemartin/utils';
+
+export type CVAConfig<T> = NonNullable<GetClosureArgs<typeof cva<T>>[1]>;
+export type CVAProps<T> = NonNullable<GetClosureArgs<GetClosureResult<typeof cva<T>>>[0]>;
+export type Variants<T extends Record<string, string | boolean>> = Required<{
+    [K in keyof T]: Exclude<T[K], undefined> extends string
+        ? { [key in Exclude<T[K], undefined>]: string | null }
+        : { true: string | null; false: string | null };
+}>;
+
+export type ComponentPropDefinitions<T> = {
+    [K in keyof T]: {
+        type?: PropType<T[K]>;
+        default: T[K] | (() => T[K]) | null;
+    };
+};
+
+export type PickComponentProps<TValues, TDefinitions> = {
+    [K in keyof TValues]: K extends keyof TDefinitions ? TValues[K] : never;
+};
+
+export function variantClasses<T>(
+    value: { baseClasses?: string } & CVAProps<T>,
+    config: { baseClasses?: string } & CVAConfig<T>,
+): string {
+    const { baseClasses: valueBaseClasses, ...values } = value;
+    const { baseClasses: configBaseClasses, ...configs } = config;
+    const variants = cva(configBaseClasses, configs as CVAConfig<T>);
+
+    return classes(variants(values as CVAProps<T>), unref(valueBaseClasses));
+}
+
+export function classes(...inputs: ClassValue[]): string {
+    return twMerge(clsx(inputs));
+}

package/src/utils/composition/events.ts

@@ -6,7 +6,6 @@ import type {
     EventWithPayload,
     EventWithoutPayload,
     EventsPayload,
-    UnknownEvent,
 } from '@aerogel/core/services/Events';
 
 export function useEvent<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): void;
@@ -14,11 +13,10 @@ 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 {
-    const unsubscribe = Events.on(event, listener);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const unsubscribe = Events.on(event as any, listener);
 
     onUnmounted(() => unsubscribe());
 }

package/src/utils/composition/forms.ts

@@ -1,7 +1,22 @@
 import { objectWithout } from '@noeldemartin/utils';
-import { computed, useAttrs } from 'vue';
+import { computed, inject, onUnmounted, useAttrs } from 'vue';
 import type { ClassValue } from 'clsx';
 import type { ComputedRef } from 'vue';
+import type { Nullable } from '@noeldemartin/utils';
+
+import FormController from '@aerogel/core/forms/FormController';
+import type { FormData, FormFieldDefinitions } from '@aerogel/core/forms/FormController';
+
+export function onFormFocus(input: { name: Nullable<string> }, listener: () => unknown): void {
+    const form = inject<FormController | null>('form', null);
+    const stop = form?.on('focus', (name) => input.name === name && listener());
+
+    onUnmounted(() => stop?.());
+}
+
+export function useForm<const T extends FormFieldDefinitions>(fields: T): FormController<T> & FormData<T> {
+    return new FormController(fields) as FormController<T> & FormData<T>;
+}
 
 export function useInputAttrs(): [ComputedRef<{}>, ComputedRef<ClassValue>] {
     const attrs = useAttrs();

package/src/utils/composition/state.ts

@@ -1,12 +1,21 @@
 import { debounce } from '@noeldemartin/utils';
-import { ref, watchEffect } from 'vue';
-import type { ComputedGetter, ComputedRef } from '@vue/runtime-core';
+import { computed, ref, watch, watchEffect } from 'vue';
+import type { ComputedGetter, ComputedRef, Ref } from 'vue';
 
 export interface ComputedDebounceOptions<T> {
     initial?: T;
     delay?: number;
 }
 
+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 computedDebounce<T>(options: ComputedDebounceOptions<T>, getter: ComputedGetter<T>): ComputedRef<T>;
 export function computedDebounce<T>(getter: ComputedGetter<T>): ComputedRef<T | null>;
 export function computedDebounce<T>(

package/src/utils/index.ts

@@ -1,7 +1,9 @@
+export * from './classes';
 export * from './composition/events';
 export * from './composition/forms';
 export * from './composition/hooks';
 export * from './composition/persistent';
+export * from './composition/state';
 export * from './markdown';
-export * from './tailwindcss';
+export * from './types';
 export * from './vue';

package/src/utils/markdown.ts

@@ -2,10 +2,18 @@ import DOMPurify from 'dompurify';
 import { stringMatchAll, tap } from '@noeldemartin/utils';
 import { Renderer, marked } from 'marked';
 
+let router: MarkdownRouter | null = null;
+
 function makeRenderer(): Renderer {
     return tap(new Renderer(), (renderer) => {
         renderer.link = function(link) {
-            return Renderer.prototype.link.apply(this, [link]).replace('<a', '<a target="_blank"');
+            const defaultLink = Renderer.prototype.link.apply(this, [link]);
+
+            if (!link.href.startsWith('#')) {
+                return defaultLink.replace('<a', '<a target="_blank"');
+            }
+
+            return defaultLink;
         };
     });
 }
@@ -20,11 +28,37 @@ function renderActionLinks(html: string): string {
     return html;
 }
 
+function renderRouteLinks(html: string): string {
+    const matches = stringMatchAll<3>(html, /<a[^>]*href="#route:([^"]+)"[^>]*>([^<]+)<\/a>/g);
+
+    for (const [link, route, text] of matches) {
+        const url = router?.resolve(route) ?? route;
+
+        html = html.replace(link, `<a data-markdown-route="${route}" href="${url}">${text}</a>`);
+    }
+
+    return html;
+}
+
+export interface MarkdownRouter {
+    resolve(route: string): string;
+    visit(route: string): Promise<void>;
+}
+
+export function getMarkdownRouter(): MarkdownRouter | null {
+    return router;
+}
+
+export function setMarkdownRouter(markdownRouter: MarkdownRouter): void {
+    router = markdownRouter;
+}
+
 export function renderMarkdown(markdown: string): string {
     let html = marked(markdown, { renderer: makeRenderer(), async: false });
 
     html = safeHtml(html);
     html = renderActionLinks(html);
+    html = renderRouteLinks(html);
 
     return html;
 }

package/src/utils/types.ts

@@ -0,0 +1,3 @@
+import type { Nullable } from '@noeldemartin/utils';
+
+export type Falsifiable<T> = Nullable<T> | false;