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

package/src/components/modals/AGAlertModal.vue

@@ -1,26 +1,14 @@
 <template>
-    <AGModal>
-        <AGMarkdown
-            v-if="title"
-            :text="title"
-            as="h2"
-            class="font-semibold"
-            raw
-            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,27 @@
+import { computed } from 'vue';
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithoutEmpty } from '@noeldemartin/utils';
+
+import { requiredStringProp, stringProp } from '@/utils';
+import { translateWithDefault } from '@/lang';
+
+export const confirmModalProps = {
+    title: stringProp(),
+    message: requiredStringProp(),
+    acceptText: stringProp(),
+    cancelText: stringProp(),
+};
+
+export type AGConfirmModalProps = ObjectWithoutEmpty<ExtractPropTypes<typeof confirmModalProps>>;
+
+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 }: IAGModalDefaultSlotProps" :cancellable="false">
-        <AGMarkdown v-if="title" :text="title" as="h1" />
+    <AGModal v-slot="{ close }: IAGModalDefaultSlotProps" :cancellable="false" :title="title">
         <AGMarkdown :text="message" />
 
         <div class="mt-2 flex flex-row-reverse gap-2">
             <AGButton @click="close(true)">
-                {{ $td('ui.ok', 'OK') }}
+                {{ renderedAcceptText }}
             </AGButton>
-            <AGButton secondary @click="close()">
-                {{ $td('ui.cancel', 'Cancel') }}
+            <AGButton color="secondary" @click="close()">
+                {{ renderedCancelText }}
             </AGButton>
         </div>
     </AGModal>
 </template>
 
 <script setup lang="ts">
-import { requiredStringProp, stringProp } from '@/utils/vue';
-
 import AGModal from './AGModal.vue';
+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

@@ -0,0 +1,46 @@
+import { computed, ref } from 'vue';
+import type { Component, ExtractPropTypes } from 'vue';
+import type { ObjectWithoutEmpty } from '@noeldemartin/utils';
+
+import { requiredArrayProp } from '@/utils/vue';
+import { translateWithDefault } from '@/lang';
+import type { ErrorReport } from '@/errors';
+
+export interface IAGErrorReportModalButtonsDefaultSlotProps {
+    id: string;
+    description: string;
+    iconComponent: Component;
+    url?: string;
+    handler?(): void;
+}
+
+export const errorReportModalProps = {
+    reports: requiredArrayProp<ErrorReport>(),
+};
+
+export type AGErrorReportModalProps = ObjectWithoutEmpty<ExtractPropTypes<typeof errorReportModalProps>>;
+
+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

@@ -0,0 +1,54 @@
+<template>
+    <AGModal>
+        <div>
+            <h2 class="flex items-center justify-between text-lg font-medium">
+                <div class="flex items-center">
+                    <AGErrorReportModalTitle
+                        :report="report"
+                        :current-report="activeReportIndex + 1"
+                        :total-reports="reports.length"
+                    />
+                    <template v-if="reports.length > 1">
+                        <AGButton
+                            color="clear"
+                            :disabled="activeReportIndex === 0"
+                            :title="previousReportText"
+                            :aria-label="previousReportText"
+                            @click="activeReportIndex--"
+                        >
+                            <IconCheveronLeft aria-hidden="true" class="h-4 w-4" />
+                        </AGButton>
+                        <AGButton
+                            color="clear"
+                            :disabled="activeReportIndex === reports.length - 1"
+                            :title="nextReportText"
+                            :aria-label="nextReportText"
+                            @click="activeReportIndex++"
+                        >
+                            <IconCheveronRight aria-hidden="true" class="h-4 w-4" />
+                        </AGButton>
+                    </template>
+                </div>
+                <AGErrorReportModalButtons :report="report" />
+            </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="details" />
+    </AGModal>
+</template>
+
+<script setup lang="ts">
+import IconCheveronRight from '~icons/zondicons/cheveron-right';
+import IconCheveronLeft from '~icons/zondicons/cheveron-left';
+
+import { useErrorReportModal, useErrorReportModalProps } from './AGErrorReportModal';
+
+import AGButton from '../forms/AGButton.vue';
+import AGErrorReportModalButtons from './AGErrorReportModalButtons.vue';
+import AGErrorReportModalTitle from './AGErrorReportModalTitle.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
+import AGModal from './AGModal.vue';
+
+const props = defineProps(useErrorReportModalProps());
+const { activeReportIndex, details, nextReportText, previousReportText, report } = useErrorReportModal(props);
+</script>

package/src/components/modals/AGErrorReportModalButtons.vue

@@ -0,0 +1,111 @@
+<template>
+    <div class="flex">
+        <slot v-for="(button, i) of buttons" v-bind="(button as unknown as ComponentProps)" :key="i">
+            <AGButton
+                color="clear"
+                :url="button.url"
+                :title="$td(`errors.report_${button.id}`, button.description)"
+                :aria-label="$td(`errors.report_${button.id}`, button.description)"
+                @click="button.handler"
+            >
+                <component :is="button.iconComponent" class="h-4 w-4" aria-hidden="true" />
+            </AGButton>
+        </slot>
+    </div>
+</template>
+
+<script setup lang="ts">
+import IconConsole from '~icons/mdi/console';
+import IconCopy from '~icons/zondicons/copy';
+import IconGitHub from '~icons/mdi/github';
+
+import { computed } from 'vue';
+import { stringExcerpt, tap } from '@noeldemartin/utils';
+
+import App from '@/services/App';
+import UI from '@/ui/UI';
+import { requiredObjectProp } from '@/utils/vue';
+import { translateWithDefault } from '@/lang/utils';
+import type { ComponentProps } from '@/utils/vue';
+import type { ErrorReport } from '@/errors';
+
+import AGButton from '../forms/AGButton.vue';
+import type { IAGErrorReportModalButtonsDefaultSlotProps } from './AGErrorReportModal';
+
+const props = defineProps({
+    report: requiredObjectProp<ErrorReport>(),
+});
+const summary = computed(() =>
+    props.report.description ? `${props.report.title}: ${props.report.description}` : props.report.title);
+const githubReportUrl = computed(() => {
+    if (!App.sourceUrl) {
+        return false;
+    }
+
+    const issueTitle = encodeURIComponent(summary.value);
+    const issueBody = encodeURIComponent(
+        [
+            '[Please, explain here what you were trying to do when this error appeared]',
+            '',
+            'Error details:',
+            '```',
+            stringExcerpt(
+                props.report.details ?? 'Details missing from report',
+                1800 - issueTitle.length - App.sourceUrl.length,
+            ).trim(),
+            '```',
+        ].join('\n'),
+    );
+
+    return `${App.sourceUrl}/issues/new?title=${issueTitle}&body=${issueBody}`;
+});
+const buttons = computed(() =>
+    tap(
+        [
+            {
+                id: 'clipboard',
+                description: 'Copy to clipboard',
+                iconComponent: IconCopy,
+                async handler() {
+                    await navigator.clipboard.writeText(`${summary.value}\n\n${props.report.details}`);
+
+                    UI.showSnackbar(
+                        translateWithDefault('errors.copiedToClipboard', 'Debug information copied to clipboard'),
+                    );
+                },
+            },
+            {
+                id: 'console',
+                description: 'Log to console',
+                iconComponent: IconConsole,
+                handler() {
+                    const error = props.report.error ?? props.report;
+
+                    (window as { error?: unknown }).error = error;
+
+                    // eslint-disable-next-line no-console
+                    console.error(error);
+
+                    UI.showSnackbar(
+                        translateWithDefault(
+                            'errors.addedToConsole',
+                            'You can now use the **error** variable in the console',
+                        ),
+                    );
+                },
+            },
+        ],
+        (reportButtons: IAGErrorReportModalButtonsDefaultSlotProps[]) => {
+            if (!githubReportUrl.value) {
+                return;
+            }
+
+            reportButtons.push({
+                id: 'github',
+                description: 'Report in GitHub',
+                iconComponent: IconGitHub,
+                url: githubReportUrl.value,
+            });
+        },
+    ));
+</script>

package/src/components/modals/AGErrorReportModalTitle.vue

@@ -0,0 +1,25 @@
+<template>
+    <AGMarkdown :text="text" inline />
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import { numberProp, requiredObjectProp } from '@/utils/vue';
+import type { ErrorReport } from '@/errors';
+
+import AGMarkdown from '../lib/AGMarkdown.vue';
+
+const props = defineProps({
+    report: requiredObjectProp<ErrorReport>(),
+    currentReport: numberProp(),
+    totalReports: numberProp(),
+});
+const text = computed(() => {
+    if (!props.totalReports || props.totalReports <= 1) {
+        return props.report.title;
+    }
+
+    return `${props.report.title} (${props.currentReport}/${props.totalReports})`;
+});
+</script>

package/src/components/modals/AGLoadingModal.ts

@@ -0,0 +1,23 @@
+import { computed } from 'vue';
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithoutEmpty } from '@noeldemartin/utils';
+
+import { stringProp } from '@/utils';
+import { translateWithDefault } from '@/lang';
+
+export const loadingModalProps = {
+    message: stringProp(),
+};
+
+export type AGLoadingModalProps = ObjectWithoutEmpty<ExtractPropTypes<typeof loadingModalProps>>;
+
+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...'));
+
+    return { renderedMessage };
+}

package/src/components/modals/AGLoadingModal.vue

@@ -0,0 +1,15 @@
+<template>
+    <AGModal :cancellable="false">
+        <AGMarkdown :text="renderedMessage" />
+    </AGModal>
+</template>
+
+<script setup lang="ts">
+import AGModal from './AGModal.vue';
+import { useLoadingModal, useLoadingModalProps } from './AGLoadingModal';
+
+import AGMarkdown from '../lib/AGMarkdown.vue';
+
+const props = defineProps(useLoadingModalProps());
+const { renderedMessage } = useLoadingModal(props);
+</script>

package/src/components/modals/AGModal.ts

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

package/src/components/modals/AGModal.vue

@@ -1,8 +1,16 @@
 <template>
-    <AGHeadlessModal v-slot="{ close }: IAGHeadlessModalDefaultSlotProps" class="relative z-50">
-        <div class="fixed inset-0 flex items-center justify-center">
-            <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">
+    <AGHeadlessModal
+        ref="$modal"
+        v-slot="{ close }: IAGHeadlessModalDefaultSlotProps"
+        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 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>
@@ -11,8 +19,21 @@
 </template>
 
 <script setup lang="ts">
-import type { IAGHeadlessModalDefaultSlotProps } from '@/components/headless/modals/AGHeadlessModal';
+import { ref } from 'vue';
+
+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 props = defineProps(useModalProps());
+const $modal = ref<IAGHeadlessModal>();
+
+defineOptions({ inheritAttrs: false });
+defineExpose<IAGModal>(useModalExpose($modal));
 </script>

package/src/components/modals/AGModalTitle.vue

@@ -0,0 +1,9 @@
+<template>
+    <AGHeadlessModalTitle class="mb-2 font-semibold">
+        <slot />
+    </AGHeadlessModalTitle>
+</template>
+
+<script setup lang="ts">
+import AGHeadlessModalTitle from '../headless/modals/AGHeadlessModalTitle.vue';
+</script>

package/src/components/modals/AGPromptModal.ts

@@ -0,0 +1,30 @@
+import { computed } from 'vue';
+import type { ExtractPropTypes } from 'vue';
+import type { ObjectWithoutEmpty } from '@noeldemartin/utils';
+
+import { requiredStringProp, stringProp } from '@/utils';
+import { translateWithDefault } from '@/lang';
+
+export const promptModalProps = {
+    title: stringProp(),
+    message: requiredStringProp(),
+    label: stringProp(),
+    defaultValue: stringProp(),
+    placeholder: stringProp(),
+    acceptText: stringProp(),
+    cancelText: stringProp(),
+};
+
+export type AGPromptModalProps = ObjectWithoutEmpty<ExtractPropTypes<typeof promptModalProps>>;
+
+export function usePromptModalProps(): typeof promptModalProps {
+    return promptModalProps;
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function usePromptModal(props: ExtractPropTypes<typeof promptModalProps>) {
+    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/AGPromptModal.vue

@@ -0,0 +1,34 @@
+<template>
+    <AGModal v-slot="{ close }: IAGModalDefaultSlotProps" :cancellable="false" :title="title">
+        <AGMarkdown :text="message" />
+
+        <AGForm :form="form" @submit="close(form.draft)">
+            <AGInput name="draft" :placeholder="placeholder" :label="label" />
+
+            <div class="mt-2 flex flex-row-reverse gap-2">
+                <AGButton submit>
+                    {{ renderedAcceptText }}
+                </AGButton>
+                <AGButton color="secondary" @click="close()">
+                    {{ renderedCancelText }}
+                </AGButton>
+            </div>
+        </AGForm>
+    </AGModal>
+</template>
+
+<script setup lang="ts">
+import AGModal from './AGModal.vue';
+import { usePromptModal, usePromptModalProps } from './AGPromptModal';
+import type { IAGModalDefaultSlotProps } from './AGModal';
+
+import AGButton from '../forms/AGButton.vue';
+import AGForm from '../forms/AGForm.vue';
+import AGInput from '../forms/AGInput.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
+import { requiredStringInput, useForm } from '../../forms';
+
+const props = defineProps(usePromptModalProps());
+const form = useForm({ draft: requiredStringInput(props.defaultValue ?? '') });
+const { renderedAcceptText, renderedCancelText } = usePromptModal(props);
+</script>

package/src/components/modals/index.ts

@@ -1,7 +1,17 @@
-import AGAlertModal from './AGAlertModal.vue';
-import AGConfirmModal from './AGConfirmModal.vue';
-import AGModal from './AGModal.vue';
-import AGModalContext from './AGModalContext.vue';
-import { IAGModal } from './AGModal';
+export * from './AGAlertModal';
+export * from './AGConfirmModal';
+export * from './AGErrorReportModal';
+export * from './AGLoadingModal';
+export * from './AGModal';
+export * from './AGModalContext';
+export * from './AGPromptModal';
 
-export { AGAlertModal, AGConfirmModal, AGModal, AGModalContext, IAGModal };
+export { default as AGAlertModal } from './AGAlertModal.vue';
+export { default as AGConfirmModal } from './AGConfirmModal.vue';
+export { default as AGErrorReportModalButtons } from './AGErrorReportModalButtons.vue';
+export { default as AGErrorReportModalTitle } from './AGErrorReportModalTitle.vue';
+export { default as AGLoadingModal } from './AGLoadingModal.vue';
+export { default as AGModal } from './AGModal.vue';
+export { default as AGModalContext } from './AGModalContext.vue';
+export { default as AGModalTitle } from './AGModalTitle.vue';
+export { default as AGPromptModal } from './AGPromptModal.vue';

package/src/components/snackbars/AGSnackbar.vue

@@ -0,0 +1,36 @@
+<template>
+    <AGHeadlessSnackbar class="flex flex-row items-center justify-center gap-3 p-4" :class="styleClasses">
+        <AGMarkdown :text="message" inline />
+        <AGButton
+            v-for="(action, i) of actions"
+            :key="i"
+            :color="color"
+            @click="activate(action)"
+        >
+            {{ action.text }}
+        </AGButton>
+    </AGHeadlessSnackbar>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import { Colors } from '@/components/constants';
+import { useSnackbar, useSnackbarProps } from '@/components/headless/snackbars';
+
+import AGButton from '../forms/AGButton.vue';
+import AGHeadlessSnackbar from '../headless/snackbars/AGHeadlessSnackbar.vue';
+import AGMarkdown from '../lib/AGMarkdown.vue';
+
+const props = defineProps(useSnackbarProps());
+const { activate } = useSnackbar(props);
+const styleClasses = computed(() => {
+    switch (props.color) {
+        case Colors.Danger:
+            return 'bg-red-200 text-red-900';
+        default:
+        case Colors.Secondary:
+            return 'bg-gray-900 text-white';
+    }
+});
+</script>

package/src/components/snackbars/index.ts

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

package/src/components/utils.ts

@@ -0,0 +1,10 @@
+export function extractComponentProps<T extends Record<string, unknown>>(
+    values: Record<string, unknown>,
+    definitions: Record<string, unknown>,
+): T {
+    return Object.keys(definitions).reduce((extracted, prop) => {
+        extracted[prop] = values[prop];
+
+        return extracted;
+    }, {} as Record<string, unknown>) as T;
+}

package/src/directives/index.ts

@@ -3,13 +3,30 @@ import type { Directive } from 'vue';
 import { definePlugin } from '@/plugins';
 
 import initialFocus from './initial-focus';
+import measure from './measure';
 
-const directives: Record<string, Directive> = {
+const builtInDirectives: Record<string, Directive> = {
     'initial-focus': initialFocus,
+    'measure': measure,
 };
 
+export * from './measure';
+
 export default definePlugin({
-    install(app) {
-        Object.entries(directives).forEach(([name, directive]) => app.directive(name, directive));
+    install(app, options) {
+        const directives = {
+            ...builtInDirectives,
+            ...options.directives,
+        };
+
+        for (const [name, directive] of Object.entries(directives)) {
+            app.directive(name, directive);
+        }
     },
 });
+
+declare module '@/bootstrap/options' {
+    export interface AerogelOptions {
+        directives?: Record<string, Directive>;
+    }
+}

package/src/directives/measure.ts

@@ -0,0 +1,21 @@
+import { defineDirective } from '@/utils/vue';
+
+export interface ElementSize {
+    width: number;
+    height: number;
+}
+
+export type MeasureDirectiveListener = (size: ElementSize) => unknown;
+
+export default defineDirective({
+    mounted(element: HTMLElement, { value }) {
+        const listener = typeof value === 'function' ? (value as MeasureDirectiveListener) : null;
+        const sizes = element.getBoundingClientRect();
+
+        // TODO guard with modifiers.css once typed properly
+        element.style.setProperty('--width', `${sizes.width}px`);
+        element.style.setProperty('--height', `${sizes.height}px`);
+
+        listener?.({ width: sizes.width, height: sizes.height });
+    },
+});