@aerogel/core 0.0.0-next.d7394c3aa6aac799b0971e63819a8713d05a5123 → 0.0.0-next.eed7a057cf5b844cd9f7fc6bda2d8df49fcd6736

package/src/ui/UI.ts

@@ -1,12 +1,19 @@
-import { after, facade, fail, uuid } from '@noeldemartin/utils';
+import { after, facade, fail, isDevelopment, required, 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 App from '@aerogel/core/services/App';
+import Events from '@aerogel/core/services/Events';
+import type { AcceptRefs } from '@aerogel/core/utils';
+import type { Color } from '@aerogel/core/components/constants';
+import type { SnackbarAction, SnackbarColor } from '@aerogel/core/components/headless/snackbars';
+import type {
+    AGAlertModalProps,
+    AGConfirmModalProps,
+    AGLoadingModalProps,
+    AGPromptModalProps,
+} from '@aerogel/core/components';
 
 import Service from './UI.state';
 import { MOBILE_BREAKPOINT, getCurrentLayout } from './utils';
@@ -18,9 +25,8 @@ interface ModalCallbacks<T = unknown> {
 }
 
 type ModalProperties<TComponent> = TComponent extends ModalComponent<infer TProperties, unknown> ? TProperties : never;
-type ModalResult<TComponent> = TComponent extends ModalComponent<Record<string, unknown>, infer TResult>
-    ? TResult
-    : never;
+type ModalResult<TComponent> =
+    TComponent extends ModalComponent<Record<string, unknown>, infer TResult> ? TResult : never;
 
 export const UIComponents = {
     AlertModal: 'alert-modal',
@@ -34,14 +40,28 @@ export const UIComponents = {
 
 export type UIComponent = ObjectValues<typeof UIComponents>;
 
-export interface ConfirmOptions {
+export type ConfirmCheckboxes = Record<string, { label: string; default?: boolean; required?: boolean }>;
+
+export type ConfirmOptions = AcceptRefs<{
     acceptText?: string;
     acceptColor?: Color;
     cancelText?: string;
     cancelColor?: Color;
+    actions?: Record<string, () => unknown>;
+    required?: boolean;
+}>;
+
+export type LoadingOptions = AcceptRefs<{
+    title?: string;
+    message?: string;
+    progress?: number;
+}>;
+
+export interface ConfirmOptionsWithCheckboxes<T extends ConfirmCheckboxes = ConfirmCheckboxes> extends ConfirmOptions {
+    checkboxes?: T;
 }
 
-export interface PromptOptions {
+export type PromptOptions = AcceptRefs<{
     label?: string;
     defaultValue?: string;
     placeholder?: string;
@@ -50,7 +70,7 @@ export interface PromptOptions {
     cancelText?: string;
     cancelColor?: Color;
     trim?: boolean;
-}
+}>;
 
 export interface ShowSnackbarOptions {
     component?: Component;
@@ -84,35 +104,66 @@ export class UIService extends Service {
         this.openModal(this.requireComponent(UIComponents.AlertModal), getProperties());
     }
 
+    /* eslint-disable max-len */
     public async confirm(message: string, options?: ConfirmOptions): Promise<boolean>;
     public async confirm(title: string, message: string, options?: ConfirmOptions): Promise<boolean>;
+    public async confirm<T extends ConfirmCheckboxes>(message: string, options?: ConfirmOptionsWithCheckboxes<T>): Promise<[boolean, Record<keyof T, boolean>]>; // prettier-ignore
+    public async confirm<T extends ConfirmCheckboxes>(title: string, message: string, options?: ConfirmOptionsWithCheckboxes<T>): Promise<[boolean, Record<keyof T, boolean>]>; // prettier-ignore
+    /* eslint-enable max-len */
+
     public async confirm(
         messageOrTitle: string,
-        messageOrOptions?: string | ConfirmOptions,
-        options?: ConfirmOptions,
-    ): Promise<boolean> {
+        messageOrOptions?: string | ConfirmOptions | ConfirmOptionsWithCheckboxes,
+        options?: ConfirmOptions | ConfirmOptionsWithCheckboxes,
+    ): Promise<boolean | [boolean, Record<string, boolean>]> {
         const getProperties = (): AGConfirmModalProps => {
             if (typeof messageOrOptions !== 'string') {
                 return {
-                    message: messageOrTitle,
                     ...(messageOrOptions ?? {}),
+                    message: messageOrTitle,
+                    required: !!messageOrOptions?.required,
                 };
             }
 
             return {
+                ...(options ?? {}),
                 title: messageOrTitle,
                 message: messageOrOptions,
-                ...(options ?? {}),
+                required: !!options?.required,
             };
         };
-
-        const modal = await this.openModal<ModalComponent<AGConfirmModalProps, boolean>>(
-            this.requireComponent(UIComponents.ConfirmModal),
-            getProperties(),
-        );
+        const properties = getProperties();
+        const modal = await this.openModal<
+            ModalComponent<AGConfirmModalProps, boolean | [boolean, Record<string, boolean>]>
+        >(this.requireComponent(UIComponents.ConfirmModal), properties);
         const result = await modal.beforeClose;
 
-        return result ?? false;
+        const confirmed = typeof result === 'object' ? result[0] : (result ?? false);
+        const checkboxes =
+            typeof result === 'object'
+                ? result[1]
+                : Object.entries(properties.checkboxes ?? {}).reduce(
+                    (values, [checkbox, { default: defaultValue }]) => ({
+                        [checkbox]: defaultValue ?? false,
+                        ...values,
+                    }),
+                      {} as Record<string, boolean>,
+                );
+
+        for (const [name, checkbox] of Object.entries(properties.checkboxes ?? {})) {
+            if (!checkbox.required || checkboxes[name]) {
+                continue;
+            }
+
+            if (confirmed && isDevelopment()) {
+                // eslint-disable-next-line no-console
+                console.warn(`Confirmed confirm modal was suppressed because required '${name}' checkbox was missing`);
+            }
+
+            return [false, checkboxes];
+        }
+
+        return 'checkboxes' in properties ? [confirmed, checkboxes] : confirmed;
     }
 
     public async prompt(message: string, options?: PromptOptions): Promise<string | null>;
@@ -128,14 +179,14 @@ export class UIService extends Service {
                 return {
                     message: messageOrTitle,
                     ...(messageOrOptions ?? {}),
-                };
+                } as AGPromptModalProps;
             }
 
             return {
                 title: messageOrTitle,
                 message: messageOrOptions,
                 ...(options ?? {}),
-            };
+            } as AGPromptModalProps;
         };
 
         const modal = await this.openModal<ModalComponent<AGPromptModalProps, string | null>>(
@@ -150,25 +201,35 @@ export class UIService extends Service {
 
     public async loading<T>(operation: Promise<T> | (() => T)): Promise<T>;
     public async loading<T>(message: string, operation: Promise<T> | (() => T)): Promise<T>;
+    public async loading<T>(options: LoadingOptions, operation: Promise<T> | (() => T)): Promise<T>;
     public async loading<T>(
-        messageOrOperation: string | Promise<T> | (() => T),
+        operationOrMessageOrOptions: string | LoadingOptions | Promise<T> | (() => T),
         operation?: Promise<T> | (() => T),
     ): Promise<T> {
-        const getProperties = (): AGLoadingModalProps => {
-            if (typeof messageOrOperation !== 'string') {
-                return {};
+        const processOperation = (o: Promise<T> | (() => T)) => (typeof o === 'function' ? Promise.resolve(o()) : o);
+        const processArgs = (): { operationPromise: Promise<T>; props?: AGLoadingModalProps } => {
+            if (typeof operationOrMessageOrOptions === 'string') {
+                return {
+                    props: { message: operationOrMessageOrOptions },
+                    operationPromise: processOperation(operation as Promise<T> | (() => T)),
+                };
+            }
+
+            if (typeof operationOrMessageOrOptions === 'function' || operationOrMessageOrOptions instanceof Promise) {
+                return { operationPromise: processOperation(operationOrMessageOrOptions) };
             }
 
-            return { message: messageOrOperation };
+            return {
+                props: operationOrMessageOrOptions,
+                operationPromise: processOperation(operation as Promise<T> | (() => T)),
+            };
         };
 
-        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
+        const { operationPromise, props } = processArgs();
+        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), props);
 
         try {
-            operation = typeof messageOrOperation === 'string' ? (operation as () => T) : messageOrOperation;
-            operation = typeof operation === 'function' ? Promise.resolve(operation()) : operation;
-
-            const [result] = await Promise.all([operation, after({ seconds: 1 })]);
+            const [result] = await Promise.all([operationPromise, after({ seconds: 1 })]);
 
             return result;
         } finally {
@@ -230,13 +291,40 @@ export class UIService extends Service {
     }
 
     public async closeModal(id: string, result?: unknown): Promise<void> {
+        if (!App.isMounted()) {
+            await this.removeModal(id, result);
+
+            return;
+        }
+
         await Events.emit('close-modal', { id, result });
     }
 
-    protected async boot(): Promise<void> {
+    public async closeAllModals(): Promise<void> {
+        while (this.modals.length > 0) {
+            await this.closeModal(required(this.modals[this.modals.length - 1]).id);
+        }
+    }
+
+    protected override async boot(): Promise<void> {
         this.watchModalEvents();
         this.watchMountedEvent();
-        this.watchWindowMedia();
+        this.watchViewportBreakpoints();
+    }
+
+    private async removeModal(id: string, result?: unknown): Promise<void> {
+        this.setState(
+            'modals',
+            this.modals.filter((m) => m.id !== id),
+        );
+
+        this.modalCallbacks[id]?.closed?.(result);
+
+        delete this.modalCallbacks[id];
+
+        const activeModal = this.modals.at(-1);
+
+        await (activeModal && Events.emit('show-modal', { id: activeModal.id }));
     }
 
     private watchModalEvents(): void {
@@ -248,31 +336,24 @@ export class UIService extends Service {
             }
         });
 
-        Events.on('modal-closed', async ({ modal, result }) => {
-            this.setState(
-                'modals',
-                this.modals.filter((m) => m.id !== modal.id),
-            );
-
-            this.modalCallbacks[modal.id]?.closed?.(result);
-
-            delete this.modalCallbacks[modal.id];
-
-            const activeModal = this.modals.at(-1);
-
-            await (activeModal && Events.emit('show-modal', { id: activeModal.id }));
+        Events.on('modal-closed', async ({ modal: { id }, result }) => {
+            await this.removeModal(id, result);
         });
     }
 
     private watchMountedEvent(): void {
         Events.once('application-mounted', async () => {
-            const splash = document.getElementById('splash');
+            if (!globalThis.document || !globalThis.getComputedStyle) {
+                return;
+            }
+
+            const splash = globalThis.document.getElementById('splash');
 
             if (!splash) {
                 return;
             }
 
-            if (window.getComputedStyle(splash).opacity !== '0') {
+            if (globalThis.getComputedStyle(splash).opacity !== '0') {
                 splash.style.opacity = '0';
 
                 await after({ ms: 600 });
@@ -282,8 +363,12 @@ export class UIService extends Service {
         });
     }
 
-    private watchWindowMedia(): void {
-        const media = window.matchMedia(`(min-width: ${MOBILE_BREAKPOINT}px)`);
+    private watchViewportBreakpoints(): void {
+        if (!globalThis.matchMedia) {
+            return;
+        }
+
+        const media = globalThis.matchMedia(`(min-width: ${MOBILE_BREAKPOINT}px)`);
 
         media.addEventListener('change', () => this.setState({ layout: getCurrentLayout() }));
     }
@@ -292,7 +377,7 @@ export class UIService extends Service {
 
 export default facade(UIService);
 
-declare module '@/services/Events' {
+declare module '@aerogel/core/services/Events' {
     export interface EventsPayload {
         'close-modal': { id: string; result?: unknown };
         'hide-modal': { id: string };

package/src/ui/index.ts

@@ -1,7 +1,7 @@
 import type { Component } from 'vue';
 
-import { bootServices } from '@/services';
-import { definePlugin } from '@/plugins';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
 
 import UI, { UIComponents } from './UI';
 import AGAlertModal from '../components/modals/AGAlertModal.vue';
@@ -42,12 +42,12 @@ export default definePlugin({
     },
 });
 
-declare module '@/bootstrap/options' {
+declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
         components?: Partial<Record<UIComponent, Component>>;
     }
 }
 
-declare module '@/services' {
+declare module '@aerogel/core/services' {
     export interface Services extends UIServices {}
 }

package/src/ui/utils.ts

@@ -8,7 +8,7 @@ export const Layouts = {
 export type Layout = (typeof Layouts)[keyof typeof Layouts];
 
 export function getCurrentLayout(): Layout {
-    if (window.innerWidth > MOBILE_BREAKPOINT) {
+    if (globalThis.innerWidth > MOBILE_BREAKPOINT) {
         return Layouts.Desktop;
     }
 

package/src/utils/composition/events.ts

@@ -1,13 +1,13 @@
 import { onUnmounted } from 'vue';
 
-import Events from '@/services/Events';
+import Events from '@aerogel/core/services/Events';
 import type {
     EventListener,
     EventWithPayload,
     EventWithoutPayload,
     EventsPayload,
     UnknownEvent,
-} from '@/services/Events';
+} from '@aerogel/core/services/Events';
 
 export function useEvent<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): void;
 export function useEvent<Event extends EventWithPayload>(

package/src/utils/composition/persistent.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from 'vitest';
+import { nextTick } from 'vue';
+import { Storage } from '@noeldemartin/utils';
+
+import { persistent } from './persistent';
+
+describe('Vue persistent helper', () => {
+
+    it('serializes to localStorage', async () => {
+        // Arrange
+        const store = persistent<{ foo?: string }>('foobar', {});
+
+        // Act
+        store.foo = 'bar';
+
+        await nextTick();
+
+        // Assert
+        expect(Storage.get('foobar')).toEqual({ foo: 'bar' });
+    });
+
+    it('reads from localStorage', async () => {
+        // Arrange
+        Storage.set('foobar', { foo: 'bar' });
+
+        // Act
+        const store = persistent<{ foo?: string }>('foobar', {});
+
+        // Assert
+        expect(store.foo).toEqual('bar');
+    });
+
+});

package/src/utils/composition/persistent.ts

@@ -0,0 +1,11 @@
+import { reactive, toRaw, watch } from 'vue';
+import { Storage } from '@noeldemartin/utils';
+import type { UnwrapNestedRefs } from 'vue';
+
+export function persistent<T extends object>(name: string, defaults: T): UnwrapNestedRefs<T> {
+    const store = reactive<T>(Storage.get<T>(name) ?? defaults);
+
+    watch(store, () => Storage.set(name, toRaw(store)));
+
+    return store;
+}

package/src/utils/composition/state.test.ts

@@ -0,0 +1,47 @@
+import { after } from '@noeldemartin/utils';
+import { describe, expect, it } from 'vitest';
+import { ref } from 'vue';
+
+import { computedDebounce } from './state';
+
+describe('Vue state helpers', () => {
+
+    it('computes debounced state', async () => {
+        // Initial
+        const state = ref(0);
+        const value = computedDebounce({ delay: 90 }, () => state.value);
+
+        expect(value.value).toBe(null);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(0);
+
+        // Update
+        state.value = 42;
+
+        expect(value.value).toBe(0);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(42);
+
+        // Debounced Update
+        state.value = 23;
+
+        expect(value.value).toBe(42);
+
+        await after({ ms: 50 });
+
+        state.value = 32;
+
+        await after({ ms: 50 });
+
+        expect(value.value).toBe(42);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(32);
+    });
+
+});

package/src/utils/composition/state.ts

@@ -0,0 +1,24 @@
+import { debounce } from '@noeldemartin/utils';
+import { ref, watchEffect } from 'vue';
+import type { ComputedGetter, ComputedRef } from '@vue/runtime-core';
+
+export interface ComputedDebounceOptions<T> {
+    initial?: T;
+    delay?: number;
+}
+
+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>(
+    optionsOrGetter: ComputedGetter<T> | ComputedDebounceOptions<T>,
+    inputGetter?: ComputedGetter<T>,
+): ComputedRef<T> {
+    const inputOptions = inputGetter ? (optionsOrGetter as ComputedDebounceOptions<T>) : {};
+    const getter = inputGetter ?? (optionsOrGetter as ComputedGetter<T>);
+    const state = ref(inputOptions.initial ?? null);
+    const update = debounce((value) => (state.value = value), inputOptions.delay ?? 300);
+
+    watchEffect(() => update(getter()));
+
+    return state as unknown as ComputedRef<T>;
+}

package/src/utils/index.ts

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

package/src/utils/markdown.test.ts

@@ -0,0 +1,50 @@
+/* eslint-disable max-len */
+import { describe, expect, it } from 'vitest';
+
+import { renderMarkdown } from './markdown';
+
+describe('Markdown utils', () => {
+
+    it('renders basic markdown', () => {
+        // Arrange
+        const expectedHTML = `
+            <h1>Title</h1>
+            <p>body with <a target="_blank" href="https://example.com">link</a></p>
+            <ul>
+                <li>One</li>
+                <li>Two</li>
+                <li>Three</li>
+            </ul>
+        `;
+
+        // Act
+        const html = renderMarkdown(
+            ['# Title', 'body with [link](https://example.com)', '- One', '- Two', '- Three'].join('\n'),
+        );
+
+        // Assert
+        expect(normalizeHTML(html)).toMatch(new RegExp(normalizeHTML(expectedHTML)));
+    });
+
+    it('renders button links', () => {
+        // Arrange
+        const expectedHTML = `
+            <p><button type="button" data-markdown-action="do-something">link</button></p>
+        `;
+
+        // Act
+        const html = renderMarkdown('[link](#action:do-something)');
+
+        // Assert
+        expect(normalizeHTML(html)).toMatch(new RegExp(normalizeHTML(expectedHTML)));
+    });
+
+});
+
+function normalizeHTML(html: string): string {
+    return html
+        .split('\n')
+        .map((line) => line.trim())
+        .join('\n')
+        .trim();
+}

package/src/utils/markdown.ts

@@ -1,21 +1,34 @@
-import { tap } from '@noeldemartin/utils';
 import DOMPurify from 'dompurify';
+import { stringMatchAll, tap } from '@noeldemartin/utils';
 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"');
+        renderer.link = function(link) {
+            return Renderer.prototype.link.apply(this, [link]).replace('<a', '<a target="_blank"');
         };
     });
 }
 
+function renderActionLinks(html: string): string {
+    const matches = stringMatchAll<3>(html, /<a[^>]*href="#action:([^"]+)"[^>]*>([^<]+)<\/a>/g);
+
+    for (const [link, action, text] of matches) {
+        html = html.replace(link, `<button type="button" data-markdown-action="${action}">${text}</button>`);
+    }
+
+    return html;
+}
+
 export function renderMarkdown(markdown: string): string {
-    return safeHtml(marked(markdown, { mangle: false, headerIds: false, renderer: makeRenderer() }));
+    let html = marked(markdown, { renderer: makeRenderer(), async: false });
+
+    html = safeHtml(html);
+    html = renderActionLinks(html);
+
+    return html;
 }
 
 export function safeHtml(html: string): string {
-    // TODO improve target="_blank" exception
-    // See https://github.com/cure53/DOMPurify/issues/317
     return DOMPurify.sanitize(html, { ADD_ATTR: ['target'] });
 }

package/src/utils/vue.ts

@@ -1,6 +1,6 @@
-import { fail } from '@noeldemartin/utils';
+import { fail, toString } from '@noeldemartin/utils';
 import { computed, inject, reactive, ref, watch } from 'vue';
-import type { Directive, InjectionKey, PropType, Ref, UnwrapNestedRefs } from 'vue';
+import type { Directive, InjectionKey, MaybeRef, PropType, Ref, UnwrapNestedRefs } from 'vue';
 
 type BaseProp<T> = {
     type?: PropType<T>;
@@ -10,7 +10,10 @@ type BaseProp<T> = {
 type RequiredProp<T> = BaseProp<T> & { required: true };
 type OptionalProp<T> = BaseProp<T> & { default: T | (() => T) | null };
 
+export type AcceptRefs<T> = { [K in keyof T]: T[K] | RefUnion<T[K]> };
 export type ComponentProps = Record<string, unknown>;
+export type RefUnion<T> = T extends infer R ? Ref<R> : never;
+export type Unref<T> = { [K in keyof T]: T[K] extends MaybeRef<infer Value> ? Value : T[K] };
 
 export function arrayProp<T>(defaultValue?: () => T[]): OptionalProp<T[]> {
     return {
@@ -66,11 +69,18 @@ export function injectReactiveOrFail<T extends object>(
     key: InjectionKey<T> | string,
     errorMessage?: string,
 ): UnwrapNestedRefs<T> {
-    return injectReactive(key) ?? fail(errorMessage ?? `Could not resolve '${key}' injection key`);
+    return injectReactive(key) ?? fail(errorMessage ?? `Could not resolve '${toString(key)}' injection key`);
 }
 
 export function injectOrFail<T>(key: InjectionKey<T> | string, errorMessage?: string): T {
-    return inject(key) ?? fail(errorMessage ?? `Could not resolve '${key}' injection key`);
+    return inject(key) ?? fail(errorMessage ?? `Could not resolve '${toString(key)}' injection key`);
+}
+
+export function listenerProp<T extends Function = Function>(): OptionalProp<T | null> {
+    return {
+        type: Function as PropType<T>,
+        default: null,
+    };
 }
 
 export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null>;