@aerogel/core 0.0.0-next.88c59e62f64db70aedfbc4c31b5bbc287be44483 → 0.0.0-next.906ec80f260b7e5cb54a0c97bd4905bdaf4bf916

package/src/components/headless/snackbars/index.ts

@@ -1,17 +1,13 @@
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithoutEmpty } from '@noeldemartin/utils';
+
+import UI from '@/ui/UI';
 import { arrayProp, enumProp, requiredStringProp } from '@/utils/vue';
 import { Colors } from '@/components/constants';
 import { objectWithout } from '@noeldemartin/utils';
 
 export { default as AGHeadlessSnackbar } from './AGHeadlessSnackbar.vue';
 
-export interface SnackbarAction {
-    text: string;
-    dismiss?: boolean;
-    handler?(): unknown;
-}
-
-export type SnackbarColor = (typeof SnackbarColors)[keyof typeof SnackbarColors];
-
 export const SnackbarColors = objectWithout(Colors, ['Primary', 'Clear']);
 export const snackbarProps = {
     id: requiredStringProp(),
@@ -20,6 +16,25 @@ export const snackbarProps = {
     color: enumProp(SnackbarColors, Colors.Secondary),
 };
 
+export interface SnackbarAction {
+    text: string;
+    dismiss?: boolean;
+    handler?(): unknown;
+}
+
+export type SnackbarColor = (typeof SnackbarColors)[keyof typeof SnackbarColors];
+export type AGSnackbarProps = ObjectWithoutEmpty<ExtractPropTypes<typeof snackbarProps>>;
+
 export function useSnackbarProps(): typeof snackbarProps {
     return snackbarProps;
 }
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function useSnackbar(props: ExtractPropTypes<typeof snackbarProps>) {
+    function activate(action: SnackbarAction): void {
+        action.handler?.();
+        action.dismiss && UI.hideSnackbar(props.id);
+    }
+
+    return { activate };
+}

package/src/components/index.ts

@@ -3,9 +3,11 @@ import AGAppOverlays from './AGAppOverlays.vue';
 
 export { AGAppLayout, AGAppOverlays };
 
-export * from './basic';
+export * from './composition';
 export * from './constants';
 export * from './forms';
 export * from './headless';
+export * from './interfaces';
+export * from './lib';
 export * from './modals';
 export * from './snackbars';

package/src/components/interfaces.ts

@@ -0,0 +1,24 @@
+import { isObject } from '@noeldemartin/utils';
+import type { Ref, UnwrapNestedRefs } from 'vue';
+
+export function getElement(value: unknown): HTMLElement | undefined {
+    if (value instanceof HTMLElement) {
+        return value;
+    }
+
+    if (hasElement(value)) {
+        return value.$el;
+    }
+}
+
+export function hasElement(value: unknown): value is UnwrapNestedRefs<HasElement> {
+    return isObject(value) && '$el' in value;
+}
+
+export interface __SetsElement {
+    __setElement(element?: HTMLElement): void;
+}
+
+export interface HasElement {
+    $el: Readonly<Ref<HTMLElement | undefined>>;
+}

package/src/components/{basic → lib}/AGErrorMessage.vue

@@ -5,12 +5,12 @@
 <script setup lang="ts">
 import { computed } from 'vue';
 
-import Errors from '@/errors/Errors';
 import { requiredObjectProp } from '@/utils/vue';
+import { getErrorMessage } from '@/errors/utils';
 import type { ErrorSource } from '@/errors/Errors.state';
 
 import AGMarkdown from './AGMarkdown.vue';
 
 const props = defineProps({ error: requiredObjectProp<ErrorSource>() });
-const message = computed(() => Errors.getErrorMessage(props.error));
+const message = computed(() => getErrorMessage(props.error));
 </script>

package/src/components/lib/AGMarkdown.vue

@@ -0,0 +1,54 @@
+<template>
+    <root />
+</template>
+
+<script setup lang="ts">
+import { computed, h, useAttrs } from 'vue';
+import { isInstanceOf } from '@noeldemartin/utils';
+
+import { renderMarkdown } from '@/utils/markdown';
+import { booleanProp, mixedProp, objectProp, stringProp } from '@/utils/vue';
+import { translate } from '@/lang';
+
+const props = defineProps({
+    as: stringProp(),
+    inline: booleanProp(),
+    langKey: stringProp(),
+    langParams: mixedProp<number | Record<string, unknown>>(),
+    text: stringProp(),
+    actions: objectProp<Record<string, () => unknown>>(),
+});
+
+const attrs = useAttrs();
+const markdown = computed(() => props.text ?? (props.langKey && translate(props.langKey, props.langParams ?? {})));
+const html = computed(() => {
+    if (!markdown.value) {
+        return null;
+    }
+
+    let renderedHtml = renderMarkdown(markdown.value);
+
+    if (props.inline) {
+        renderedHtml = renderedHtml.replace('<p>', '<span>').replace('</p>', '</span>');
+    }
+
+    return renderedHtml;
+});
+const root = () =>
+    h(props.as ?? (props.inline ? 'span' : 'div'), {
+        innerHTML: html.value,
+        onClick,
+        ...attrs,
+        class: `${attrs.class ?? ''} ${props.inline ? '' : 'prose'}`,
+    });
+
+async function onClick(event: Event) {
+    const { target } = event;
+
+    if (isInstanceOf(target, HTMLElement) && target.dataset.markdownAction) {
+        props.actions?.[target.dataset.markdownAction]?.();
+
+        return;
+    }
+}
+</script>

package/src/components/lib/AGMeasured.vue

@@ -0,0 +1,16 @@
+<template>
+    <component :is="as" v-measure="() => (measured = true)" :class="{ '!invisible !absolute !w-auto': !measured }">
+        <slot />
+    </component>
+</template>
+
+<script setup lang="ts">
+import { ref } from 'vue';
+
+import { stringProp } from '@/utils/vue';
+
+defineProps({ as: stringProp('span') });
+
+// TODO use v-measure.css
+const measured = ref(false);
+</script>

package/src/components/lib/AGProgressBar.vue

@@ -0,0 +1,55 @@
+<template>
+    <div class="mt-1 h-2 w-full overflow-hidden rounded-full bg-gray-200">
+        <div :class="barClasses" :style="`transform:translateX(-${(1 - renderedProgress) * 100}%)`" />
+        <span class="sr-only">
+            {{
+                $td('ui.progress', '{progress}% complete', {
+                    progress: renderedProgress * 100,
+                })
+            }}
+        </span>
+    </div>
+</template>
+
+<script setup lang="ts">
+import { computed, onUnmounted, ref, watch } from 'vue';
+
+import { numberProp, objectProp, stringProp } from '@/utils/vue';
+import type { Job } from '@/jobs';
+
+const props = defineProps({
+    progress: numberProp(),
+    barClass: stringProp(''),
+    job: objectProp<Job>(),
+});
+
+let cleanup: Function | undefined;
+const jobProgress = ref(0);
+const barClasses = computed(() => {
+    const classes = props.barClass ?? '';
+
+    return `h-full w-full transition-transform duration-500 ease-linear ${
+        classes.includes('bg-') ? classes : `${classes} bg-gray-700`
+    }`;
+});
+const renderedProgress = computed(() => {
+    if (typeof props.progress === 'number') {
+        return props.progress;
+    }
+
+    return jobProgress.value;
+});
+
+watch(
+    () => props.job,
+    () => {
+        cleanup?.();
+
+        jobProgress.value = props.job?.progress ?? 0;
+        cleanup = props.job?.listeners.add({ onUpdated: (progress) => (jobProgress.value = progress) });
+    },
+    { immediate: true },
+);
+
+onUnmounted(() => cleanup?.());
+</script>

package/src/components/lib/AGStartupCrash.vue

@@ -0,0 +1,31 @@
+<template>
+    <div class="grid flex-grow place-items-center">
+        <div class="flex flex-col items-center space-y-6 p-8">
+            <h1 class="mt-2 text-center text-4xl font-medium text-red-600">
+                {{ $td('startupCrash.title', 'Something went wrong!') }}
+            </h1>
+            <AGMarkdown
+                :text="
+                    $td(
+                        'startupCrash.message',
+                        'Something failed trying to start the application.\n\nHere\'s some things you can do:'
+                    )
+                "
+                class="mt-4 text-center"
+            />
+            <div class="mt-4 flex flex-col space-y-4">
+                <AGButton color="danger" @click="$app.reload()">
+                    {{ $td('startupCrash.reload', 'Try again') }}
+                </AGButton>
+                <AGButton color="danger" @click="$errors.inspect($errors.startupErrors)">
+                    {{ $td('startupCrash.inspect', 'View error details') }}
+                </AGButton>
+            </div>
+        </div>
+    </div>
+</template>
+
+<script setup lang="ts">
+import AGMarkdown from './AGMarkdown.vue';
+import AGButton from '../forms/AGButton.vue';
+</script>

package/src/components/lib/index.ts

@@ -0,0 +1,6 @@
+export { default as AGErrorMessage } from './AGErrorMessage.vue';
+export { default as AGLink } from './AGLink.vue';
+export { default as AGMarkdown } from './AGMarkdown.vue';
+export { default as AGMeasured } from './AGMeasured.vue';
+export { default as AGProgressBar } from './AGProgressBar.vue';
+export { default as AGStartupCrash } from './AGStartupCrash.vue';

package/src/components/modals/AGAlertModal.ts

@@ -0,0 +1,18 @@
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithout, Pretty } from '@noeldemartin/utils';
+
+import { requiredStringProp, stringProp } from '@/utils';
+import type { AcceptRefs } from '@/utils';
+
+export const alertModalProps = {
+    title: stringProp(),
+    message: requiredStringProp(),
+};
+
+export type AGAlertModalProps = Pretty<
+    AcceptRefs<ObjectWithout<ExtractPropTypes<typeof alertModalProps>, null | undefined>>
+>;
+
+export function useAlertModalProps(): typeof alertModalProps {
+    return alertModalProps;
+}

package/src/components/modals/AGAlertModal.vue

@@ -1,25 +1,14 @@
 <template>
-    <AGModal>
-        <AGMarkdown
-            v-if="title"
-            :text="title"
-            as="h2"
-            class="font-semibold"
-            inline
-        />
+    <AGModal :title="title">
         <AGMarkdown :text="message" />
     </AGModal>
 </template>
 
 <script setup lang="ts">
-import { requiredStringProp, stringProp } from '@/utils/vue';
-
 import AGModal from './AGModal.vue';
+import { useAlertModalProps } from './AGAlertModal';
 
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
-defineProps({
-    title: stringProp(),
-    message: requiredStringProp(),
-});
+defineProps(useAlertModalProps());
 </script>

package/src/components/modals/AGConfirmModal.ts

@@ -0,0 +1,42 @@
+import { computed } from 'vue';
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithout, Pretty, SubPartial } from '@noeldemartin/utils';
+
+import { Colors } from '@/components/constants';
+import { booleanProp, enumProp, objectProp, requiredStringProp, stringProp } from '@/utils';
+import { translateWithDefault } from '@/lang';
+import type { AcceptRefs } from '@/utils';
+import type { ConfirmCheckboxes } from '@/ui';
+
+export const confirmModalProps = {
+    title: stringProp(),
+    message: requiredStringProp(),
+    acceptText: stringProp(),
+    acceptColor: enumProp(Colors, Colors.Primary),
+    cancelText: stringProp(),
+    cancelColor: enumProp(Colors, Colors.Clear),
+    checkboxes: objectProp<ConfirmCheckboxes>(),
+    actions: objectProp<Record<string, () => unknown>>(),
+    required: booleanProp(false),
+};
+
+export type AGConfirmModalProps = Pretty<
+    AcceptRefs<
+        SubPartial<
+            ObjectWithout<ExtractPropTypes<typeof confirmModalProps>, null | undefined>,
+            'acceptColor' | 'cancelColor'
+        >
+    >
+>;
+
+export function useConfirmModalProps(): typeof confirmModalProps {
+    return confirmModalProps;
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function useConfirmModal(props: ExtractPropTypes<typeof confirmModalProps>) {
+    const renderedAcceptText = computed(() => props.acceptText ?? translateWithDefault('ui.accept', 'Ok'));
+    const renderedCancelText = computed(() => props.cancelText ?? translateWithDefault('ui.cancel', 'Cancel'));
+
+    return { renderedAcceptText, renderedCancelText };
+}

package/src/components/modals/AGConfirmModal.vue

@@ -1,30 +1,26 @@
 <template>
-    <AGModal v-slot="{ close }: IAGModalSlotProps" :cancellable="false">
-        <AGMarkdown v-if="title" :text="title" as="h1" />
-        <AGMarkdown :text="message" />
+    <AGModal v-slot="{ close }: IAGModalDefaultSlotProps" :cancellable="false" :title="title">
+        <AGMarkdown :text="message" :actions="actions" />
 
         <div class="mt-2 flex flex-row-reverse gap-2">
-            <AGButton @click="close(true)">
-                {{ $td('ui.ok', 'OK') }}
+            <AGButton :color="acceptColor" @click="close(true)">
+                {{ renderedAcceptText }}
             </AGButton>
-            <AGButton color="secondary" @click="close()">
-                {{ $td('ui.cancel', 'Cancel') }}
+            <AGButton v-if="!required" :color="cancelColor" @click="close()">
+                {{ renderedCancelText }}
             </AGButton>
         </div>
     </AGModal>
 </template>
 
 <script setup lang="ts">
-import { requiredStringProp, stringProp } from '@/utils/vue';
-
 import AGModal from './AGModal.vue';
-import type { IAGModalSlotProps } from './AGModal';
+import { useConfirmModal, useConfirmModalProps } from './AGConfirmModal';
+import type { IAGModalDefaultSlotProps } from './AGModal';
 
 import AGButton from '../forms/AGButton.vue';
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
-defineProps({
-    title: stringProp(),
-    message: requiredStringProp(),
-});
+const props = defineProps(useConfirmModalProps());
+const { renderedAcceptText, renderedCancelText } = useConfirmModal(props);
 </script>

package/src/components/modals/AGErrorReportModal.ts

@@ -1,6 +1,10 @@
-import type { Component } from 'vue';
+import { computed, ref } from 'vue';
+import type { Component, ExtractPropTypes } from 'vue';
+import type { ObjectWithout, Pretty } from '@noeldemartin/utils';
 
 import { requiredArrayProp } from '@/utils/vue';
+import { translateWithDefault } from '@/lang';
+import type { AcceptRefs } from '@/utils/vue';
 import type { ErrorReport } from '@/errors';
 
 export interface IAGErrorReportModalButtonsDefaultSlotProps {
@@ -15,6 +19,31 @@ export const errorReportModalProps = {
     reports: requiredArrayProp<ErrorReport>(),
 };
 
+export type AGErrorReportModalProps = Pretty<
+    AcceptRefs<ObjectWithout<ExtractPropTypes<typeof errorReportModalProps>, null | undefined>>
+>;
+
 export function useErrorReportModalProps(): typeof errorReportModalProps {
     return errorReportModalProps;
 }
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function useErrorReportModal(props: ExtractPropTypes<typeof errorReportModalProps>) {
+    const activeReportIndex = ref(0);
+    const report = computed(() => props.reports[activeReportIndex.value] as ErrorReport);
+    const details = computed(
+        () =>
+            report.value.details?.trim() ||
+            translateWithDefault('errors.detailsEmpty', 'This error is missing a stacktrace.'),
+    );
+    const previousReportText = translateWithDefault('errors.previousReport', 'Show previous report');
+    const nextReportText = translateWithDefault('errors.nextReport', 'Show next report');
+
+    return {
+        activeReportIndex,
+        details,
+        nextReportText,
+        previousReportText,
+        report,
+    };
+}

package/src/components/modals/AGErrorReportModal.vue

@@ -12,8 +12,8 @@
                         <AGButton
                             color="clear"
                             :disabled="activeReportIndex === 0"
-                            :title="$td('errors.previousReport', 'Show previous report')"
-                            :aria-label="$td('errors.previousReport', 'Show previous report')"
+                            :title="previousReportText"
+                            :aria-label="previousReportText"
                             @click="activeReportIndex--"
                         >
                             <IconCheveronLeft aria-hidden="true" class="h-4 w-4" />
@@ -21,8 +21,8 @@
                         <AGButton
                             color="clear"
                             :disabled="activeReportIndex === reports.length - 1"
-                            :title="$td('errors.nextReport', 'Show next report')"
-                            :aria-label="$td('errors.nextReport', 'Show next report')"
+                            :title="nextReportText"
+                            :aria-label="nextReportText"
                             @click="activeReportIndex++"
                         >
                             <IconCheveronRight aria-hidden="true" class="h-4 w-4" />
@@ -33,10 +33,7 @@
             </h2>
             <AGMarkdown v-if="report.description" :text="report.description" class="mt-2" />
         </div>
-        <pre
-            class="h-full overflow-auto bg-gray-200 p-4 text-xs text-red-900"
-            v-text="report.details ?? $td('errors.detailsEmpty', 'This error is missing a stacktrace.')"
-        />
+        <pre class="h-full overflow-auto bg-gray-200 p-4 text-xs text-red-900" v-text="details" />
     </AGModal>
 </template>
 
@@ -44,19 +41,14 @@
 import IconCheveronRight from '~icons/zondicons/cheveron-right';
 import IconCheveronLeft from '~icons/zondicons/cheveron-left';
 
-import { computed, ref } from 'vue';
-
-import type { ErrorReport } from '@/errors';
-
-import { useErrorReportModalProps } from './AGErrorReportModal';
+import { useErrorReportModal, useErrorReportModalProps } from './AGErrorReportModal';
 
 import AGButton from '../forms/AGButton.vue';
 import AGErrorReportModalButtons from './AGErrorReportModalButtons.vue';
 import AGErrorReportModalTitle from './AGErrorReportModalTitle.vue';
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 import AGModal from './AGModal.vue';
 
 const props = defineProps(useErrorReportModalProps());
-const activeReportIndex = ref(0);
-const report = computed(() => props.reports[activeReportIndex.value] as ErrorReport);
+const { activeReportIndex, details, nextReportText, previousReportText, report } = useErrorReportModal(props);
 </script>

package/src/components/modals/AGErrorReportModalButtons.vue

@@ -79,10 +79,12 @@ const buttons = computed(() =>
                 description: 'Log to console',
                 iconComponent: IconConsole,
                 handler() {
-                    (window as { error?: unknown }).error = props.report.error;
+                    const error = props.report.error ?? props.report;
+
+                    (window as { error?: unknown }).error = error;
 
                     // eslint-disable-next-line no-console
-                    console.error(props.report.error);
+                    console.error(error);
 
                     UI.showSnackbar(
                         translateWithDefault(

package/src/components/modals/AGErrorReportModalTitle.vue

@@ -8,7 +8,7 @@ import { computed } from 'vue';
 import { numberProp, requiredObjectProp } from '@/utils/vue';
 import type { ErrorReport } from '@/errors';
 
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
 const props = defineProps({
     report: requiredObjectProp<ErrorReport>(),

package/src/components/modals/AGLoadingModal.ts

@@ -0,0 +1,29 @@
+import { computed } from 'vue';
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithout } from '@noeldemartin/utils';
+
+import { numberProp, stringProp } from '@/utils';
+import { translateWithDefault } from '@/lang';
+import type { AcceptRefs } from '@/utils';
+
+export const loadingModalProps = {
+    title: stringProp(),
+    message: stringProp(),
+    progress: numberProp(),
+};
+
+export type AGLoadingModalProps = AcceptRefs<
+    ObjectWithout<ExtractPropTypes<typeof loadingModalProps>, null | undefined>
+>;
+
+export function useLoadingModalProps(): typeof loadingModalProps {
+    return loadingModalProps;
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function useLoadingModal(props: ExtractPropTypes<typeof loadingModalProps>) {
+    const renderedMessage = computed(() => props.message ?? translateWithDefault('ui.loading', 'Loading...'));
+    const showProgress = computed(() => typeof props.progress === 'number');
+
+    return { renderedMessage, showProgress };
+}

package/src/components/modals/AGLoadingModal.vue

@@ -5,15 +5,11 @@
 </template>
 
 <script setup lang="ts">
-import { computed } from 'vue';
-
-import { stringProp } from '@/utils/vue';
-import { translateWithDefault } from '@/lang/utils';
-
 import AGModal from './AGModal.vue';
+import { useLoadingModal, useLoadingModalProps } from './AGLoadingModal';
 
-import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
-const props = defineProps({ message: stringProp() });
-const renderedMessage = computed(() => props.message ?? translateWithDefault('ui.loading', 'Loading...'));
+const props = defineProps(useLoadingModalProps());
+const { renderedMessage } = useLoadingModal(props);
 </script>

package/src/components/modals/AGModal.ts

@@ -1,10 +1,11 @@
 import type { Ref } from 'vue';
 
 export interface IAGModal {
+    inline: Ref<boolean>;
     cancellable: Ref<boolean>;
-    close(): Promise<void>;
+    close(result?: unknown): Promise<void>;
 }
 
-export interface IAGModalSlotProps {
+export interface IAGModalDefaultSlotProps {
     close(result?: unknown): Promise<void>;
 }

package/src/components/modals/AGModal.vue

@@ -1,13 +1,16 @@
 <template>
     <AGHeadlessModal
-        ref="$headlessModal"
+        ref="$modal"
         v-slot="{ close }: IAGHeadlessModalDefaultSlotProps"
-        :cancellable="cancellable"
+        v-bind="props"
         class="relative z-50"
     >
         <div class="fixed inset-0 flex items-center justify-center p-8">
-            <AGHeadlessModalPanel class="flex max-h-full max-w-full flex-col overflow-hidden bg-white">
-                <div class="flex max-h-full flex-col overflow-auto p-4" v-bind="$attrs">
+            <AGHeadlessModalPanel class="flex max-h-full max-w-full flex-col overflow-hidden bg-white p-4">
+                <AGHeadlessModalTitle v-if="title" class="mb-2 text-lg font-semibold">
+                    <AGMarkdown :text="title" inline />
+                </AGHeadlessModalTitle>
+                <div class="flex max-h-full flex-col overflow-auto" v-bind="$attrs">
                     <slot :close="close" />
                 </div>
             </AGHeadlessModalPanel>
@@ -16,22 +19,21 @@
 </template>
 
 <script setup lang="ts">
-import { computed, ref } from 'vue';
+import { ref } from 'vue';
 
-import { booleanProp } from '@/utils';
+import { useModalExpose, useModalProps } from '@/components/headless/modals/AGHeadlessModal';
 import type { IAGHeadlessModal, IAGHeadlessModalDefaultSlotProps } from '@/components/headless/modals/AGHeadlessModal';
 
 import type { IAGModal } from './AGModal';
 
 import AGHeadlessModal from '../headless/modals/AGHeadlessModal.vue';
 import AGHeadlessModalPanel from '../headless/modals/AGHeadlessModalPanel.vue';
+import AGHeadlessModalTitle from '../headless/modals/AGHeadlessModalTitle.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
 
-const $headlessModal = ref<IAGHeadlessModal>();
+const props = defineProps(useModalProps());
+const $modal = ref<IAGHeadlessModal>();
 
 defineOptions({ inheritAttrs: false });
-defineProps({ cancellable: booleanProp(true) });
-defineExpose<IAGModal>({
-    close: async () => $headlessModal.value?.close(),
-    cancellable: computed(() => !!$headlessModal.value?.cancellable),
-});
+defineExpose<IAGModal>(useModalExpose($modal));
 </script>