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

package/src/components/basic/AGMarkdown.vue

@@ -6,30 +6,31 @@
 import { computed, h } from 'vue';
 
 import { renderMarkdown } from '@/utils/markdown';
-import { booleanProp, stringProp } from '@/utils/vue';
+import { booleanProp, objectProp, stringProp } from '@/utils/vue';
 import { translate } from '@/lang';
 
 const props = defineProps({
-    as: stringProp('div'),
+    as: stringProp(),
+    inline: booleanProp(),
     langKey: stringProp(),
+    langParams: objectProp<Record<string, unknown>>(),
     text: stringProp(),
-    inline: booleanProp(),
-    raw: booleanProp(),
 });
 
-const markdown = computed(() => props.text ?? (props.langKey && translate(props.langKey)));
+const markdown = computed(() => props.text ?? (props.langKey && translate(props.langKey, props.langParams ?? {})));
 const html = computed(() => {
     if (!markdown.value) {
         return null;
     }
 
-    let html = renderMarkdown(markdown.value);
+    let renderedHtml = renderMarkdown(markdown.value);
 
     if (props.inline) {
-        html = html.replace('<p>', '<span>').replace('</p>', '</span>');
+        renderedHtml = renderedHtml.replace('<p>', '<span>').replace('</p>', '</span>');
     }
 
-    return html;
+    return renderedHtml;
 });
-const root = () => h(props.as, { class: props.raw ? '' : 'prose', innerHTML: html.value });
+const root = () =>
+    h(props.as ?? (props.inline ? 'span' : 'div'), { class: props.inline ? '' : 'prose', innerHTML: html.value });
 </script>

package/src/components/basic/index.ts

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

package/src/components/constants.ts

@@ -0,0 +1,8 @@
+export const Colors = {
+    Primary: 'primary',
+    Secondary: 'secondary',
+    Danger: 'danger',
+    Clear: 'clear',
+} as const;
+
+export type Color = (typeof Colors)[keyof typeof Colors];

package/src/components/forms/AGButton.vue

@@ -1,21 +1,44 @@
 <template>
-    <AGHeadlessButton
-        class="px-2.5 py-1.5 text-white focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2"
-        :class="{
-            'bg-indigo-600 hover:bg-indigo-500 focus-visible:outline-indigo-600': !secondary,
-            'bg-gray-600 hover:bg-gray-500 focus-visible:outline-gray-600': secondary,
-        }"
-    >
+    <AGHeadlessButton class="px-2.5 py-1.5 focus-visible:outline focus-visible:outline-2" :class="colorClasses">
         <slot />
     </AGHeadlessButton>
 </template>
 
 <script setup lang="ts">
-import { booleanProp } from '@/utils';
+import { computed } from 'vue';
+
+import { enumProp } from '@/utils/vue';
+import { Colors } from '@/components/constants';
 
 import AGHeadlessButton from '../headless/forms/AGHeadlessButton.vue';
 
-defineProps({
-    secondary: booleanProp(),
+const props = defineProps({
+    color: enumProp(Colors, Colors.Primary),
+});
+
+const colorClasses = computed(() => {
+    switch (props.color) {
+        case Colors.Secondary:
+            return [
+                'text-white bg-gray-600',
+                'hover:bg-gray-500',
+                'focus-visible:outline-offset-2 focus-visible:outline-gray-600',
+            ].join(' ');
+        case Colors.Clear:
+            return 'hover:bg-gray-500/20 focus-visible:outline-gray-500/60';
+        case Colors.Danger:
+            return [
+                'text-white bg-red-600',
+                'hover:bg-red-500',
+                'focus-visible:outline-offset-2 focus-visible:outline-red-600',
+            ].join(' ');
+        case Colors.Primary:
+        default:
+            return [
+                'text-white bg-indigo-600',
+                'hover:bg-indigo-500',
+                'focus-visible:outline-offset-2 focus-visible:outline-indigo-600',
+            ].join(' ');
+    }
 });
 </script>

package/src/components/forms/AGCheckbox.vue

@@ -0,0 +1,35 @@
+<template>
+    <AGHeadlessInput ref="$input" :name="name" class="flex">
+        <AGHeadlessInputInput
+            v-bind="$attrs"
+            type="checkbox"
+            :class="{
+                'text-indigo-600 focus:ring-indigo-600': !$input?.errors,
+                'border-red-200 text-red-600 focus:ring-red-600': $input?.errors,
+            }"
+        />
+
+        <div class="ml-2">
+            <AGHeadlessInputLabel v-if="$slots.default">
+                <slot />
+            </AGHeadlessInputLabel>
+            <AGHeadlessInputError class="text-sm text-red-600" />
+        </div>
+    </AGHeadlessInput>
+</template>
+
+<script setup lang="ts">
+import { componentRef, stringProp } from '@/utils/vue';
+
+import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
+
+import AGHeadlessInput from '../headless/forms/AGHeadlessInput.vue';
+import AGHeadlessInputError from '../headless/forms/AGHeadlessInputError.vue';
+import AGHeadlessInputInput from '../headless/forms/AGHeadlessInputInput.vue';
+import AGHeadlessInputLabel from '../headless/forms/AGHeadlessInputLabel.vue';
+
+defineProps({ name: stringProp() });
+defineOptions({ inheritAttrs: false });
+
+const $input = componentRef<IAGHeadlessInput>();
+</script>

package/src/components/forms/AGInput.vue

@@ -1,24 +1,27 @@
 <template>
     <AGHeadlessInput
         ref="$input"
-        as="div"
-        class="flex flex-col items-center"
+        class="relative flex flex-col items-center"
+        :class="className"
         :name="name"
     >
         <AGHeadlessInputInput
-            v-bind="$attrs"
+            v-bind="attrs"
             class="block w-full border-0 py-1.5 text-gray-900 ring-1 ring-inset ring-gray-300 placeholder:text-gray-400 focus:ring-2 focus:ring-inset focus:ring-indigo-600"
             :class="{
                 'ring-1 ring-red-500': $input?.errors,
             }"
         />
-        <AGHeadlessInputError class="mt-1 text-sm text-red-500" />
+        <div class="absolute bottom-0 left-0 translate-y-full">
+            <AGHeadlessInputError class="mt-1 text-sm text-red-500" />
+        </div>
     </AGHeadlessInput>
 </template>
 
 <script setup lang="ts">
 import { componentRef, stringProp } from '@/utils/vue';
 
+import { useInputAttrs } from '@/utils';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
 import AGHeadlessInput from '../headless/forms/AGHeadlessInput.vue';
@@ -29,4 +32,5 @@ defineProps({ name: stringProp() });
 defineOptions({ inheritAttrs: false });
 
 const $input = componentRef<IAGHeadlessInput>();
+const [attrs, className] = useInputAttrs();
 </script>

package/src/components/forms/index.ts

@@ -1,5 +1,6 @@
 import AGButton from './AGButton.vue';
+import AGCheckbox from './AGCheckbox.vue';
 import AGForm from './AGForm.vue';
 import AGInput from './AGInput.vue';
 
-export { AGButton, AGForm, AGInput };
+export { AGButton, AGCheckbox, AGForm, AGInput };

package/src/components/headless/forms/AGHeadlessButton.vue

@@ -7,15 +7,15 @@
 <script setup lang="ts">
 import { computed } from 'vue';
 import { objectWithoutEmpty } from '@noeldemartin/utils';
-import type { LocationQuery, RouteLocation, RouteParams } from 'vue-router';
 
 import { booleanProp, objectProp, stringProp } from '@/utils/vue';
 
-const { url, route, routeParams, routeQuery, submit } = defineProps({
+const { href, url, route, routeParams, routeQuery, submit } = defineProps({
+    href: stringProp(),
     url: stringProp(),
     route: stringProp(),
-    routeParams: objectProp<RouteParams>(() => ({})),
-    routeQuery: objectProp<LocationQuery>(() => ({})),
+    routeParams: objectProp(() => ({})),
+    routeQuery: objectProp(() => ({})),
     submit: booleanProp(),
 });
 
@@ -24,7 +24,7 @@ const component = computed(() => {
         return {
             tag: 'router-link',
             props: {
-                to: objectWithoutEmpty<Partial<RouteLocation>>({
+                to: objectWithoutEmpty({
                     name: route,
                     params: routeParams,
                     query: routeQuery,
@@ -33,12 +33,12 @@ const component = computed(() => {
         };
     }
 
-    if (url) {
+    if (href || url) {
         return {
             tag: 'a',
             props: {
                 target: '_blank',
-                href: url,
+                href: href || url,
             },
         };
     }

package/src/components/headless/forms/AGHeadlessInput.ts

@@ -2,7 +2,7 @@ import type { ComputedRef, DeepReadonly, Ref } from 'vue';
 
 export interface IAGHeadlessInput {
     id: string;
-    value: ComputedRef<string | number | null>;
+    value: ComputedRef<string | number | boolean | null>;
     errors: DeepReadonly<Ref<string[] | null>>;
-    update(value: string | number | null): void;
+    update(value: string | number | boolean | null): void;
 }

package/src/components/headless/forms/AGHeadlessInput.vue

@@ -9,16 +9,16 @@
 import { computed, inject, provide, readonly } from 'vue';
 import { uuid } from '@noeldemartin/utils';
 
-import { stringProp } from '@/utils/vue';
+import { mixedProp, stringProp } from '@/utils/vue';
 import type Form from '@/forms/Form';
 
 import type { IAGHeadlessInput } from './AGHeadlessInput';
 
 const emit = defineEmits(['update:modelValue']);
 const props = defineProps({
-    as: stringProp(),
+    as: stringProp('div'),
     name: stringProp(),
-    modelValue: stringProp(),
+    modelValue: mixedProp<string | number | boolean>([String, Number, Boolean]),
 });
 const errors = computed(() => {
     if (!form || !props.name) {

package/src/components/headless/forms/AGHeadlessInputError.vue

@@ -8,7 +8,7 @@
 import { computed } from 'vue';
 
 import { injectReactiveOrFail } from '@/utils/vue';
-import { translateWithDefault } from '@/lang';
+import { translateWithDefault } from '@/lang/utils';
 
 import type { IAGHeadlessInput } from './AGHeadlessInput';
 

package/src/components/headless/forms/AGHeadlessInputInput.vue

@@ -2,10 +2,11 @@
     <input
         :id="input.id"
         ref="$input"
-        type="text"
+        :type="type"
         :value="value"
         :aria-invalid="input.errors ? 'true' : 'false'"
         :aria-describedby="input.errors ? `${input.id}-error` : undefined"
+        :checked="checked"
         @input="update"
     >
 </template>
@@ -13,21 +14,32 @@
 <script setup lang="ts">
 import { computed, ref } from 'vue';
 
-import { injectReactiveOrFail } from '@/utils';
+import { injectReactiveOrFail, stringProp } from '@/utils';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
+const props = defineProps({
+    type: stringProp('text'),
+});
+
 const $input = ref<HTMLInputElement>();
 const input = injectReactiveOrFail<IAGHeadlessInput>(
     'input',
     '<AGHeadlessInputInput> must be a child of a <AGHeadlessInput>',
 );
 const value = computed(() => input.value);
+const checked = computed(() => {
+    if (props.type !== 'checkbox') {
+        return;
+    }
+
+    return !!value.value;
+});
 
 function update() {
     if (!$input.value) {
         return;
     }
 
-    input.update($input.value.value);
+    input.update(props.type === 'checkbox' ? $input.value.checked : $input.value.value);
 }
 </script>

package/src/components/headless/index.ts

@@ -1,2 +1,3 @@
 export * from './forms';
 export * from './modals';
+export * from './snackbars';

package/src/components/headless/modals/AGHeadlessModalPanel.vue

@@ -1,7 +1,11 @@
 <template>
     <DialogPanel>
         <slot />
-        <AGModalContext v-if="childModal" :child-index="modal.childIndex + 1" :modal="childModal" />
+
+        <template v-if="childModal">
+            <div class="pointer-events-none fixed inset-0 z-50 bg-black/30" />
+            <AGModalContext :child-index="modal.childIndex + 1" :modal="childModal" />
+        </template>
     </DialogPanel>
 </template>
 

package/src/components/headless/snackbars/AGHeadlessSnackbar.vue

@@ -0,0 +1,10 @@
+<template>
+    <div class="pointer-events-auto">
+        <slot />
+    </div>
+</template>
+
+<script setup lang="ts">
+// Stub import to fix build (otherwise, this file doesn't seem to be treated as a module).
+import 'virtual:aerogel';
+</script>

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

@@ -0,0 +1,25 @@
+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(),
+    message: requiredStringProp(),
+    actions: arrayProp<SnackbarAction>(() => []),
+    color: enumProp(SnackbarColors, Colors.Secondary),
+};
+
+export function useSnackbarProps(): typeof snackbarProps {
+    return snackbarProps;
+}

package/src/components/index.ts

@@ -4,6 +4,8 @@ import AGAppOverlays from './AGAppOverlays.vue';
 export { AGAppLayout, AGAppOverlays };
 
 export * from './basic';
+export * from './constants';
 export * from './forms';
 export * from './headless';
 export * from './modals';
+export * from './snackbars';

package/src/components/modals/AGAlertModal.vue

@@ -5,7 +5,6 @@
             :text="title"
             as="h2"
             class="font-semibold"
-            raw
             inline
         />
         <AGMarkdown :text="message" />

package/src/components/modals/AGConfirmModal.vue

@@ -7,7 +7,7 @@
             <AGButton @click="close(true)">
                 {{ $td('ui.ok', 'OK') }}
             </AGButton>
-            <AGButton secondary @click="close()">
+            <AGButton color="secondary" @click="close()">
                 {{ $td('ui.cancel', 'Cancel') }}
             </AGButton>
         </div>

package/src/components/modals/AGErrorReportModal.ts

@@ -0,0 +1,20 @@
+import type { Component } from 'vue';
+
+import { requiredArrayProp } from '@/utils/vue';
+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 function useErrorReportModalProps(): typeof errorReportModalProps {
+    return errorReportModalProps;
+}

package/src/components/modals/AGErrorReportModal.vue

@@ -0,0 +1,62 @@
+<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="$td('errors.previousReport', 'Show previous report')"
+                            :aria-label="$td('errors.previousReport', 'Show previous report')"
+                            @click="activeReportIndex--"
+                        >
+                            <IconCheveronLeft aria-hidden="true" class="h-4 w-4" />
+                        </AGButton>
+                        <AGButton
+                            color="clear"
+                            :disabled="activeReportIndex === reports.length - 1"
+                            :title="$td('errors.nextReport', 'Show next report')"
+                            :aria-label="$td('errors.nextReport', 'Show next report')"
+                            @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="report.details ?? $td('errors.detailsEmpty', 'This error is missing a stacktrace.')"
+        />
+    </AGModal>
+</template>
+
+<script setup lang="ts">
+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 AGButton from '../forms/AGButton.vue';
+import AGErrorReportModalButtons from './AGErrorReportModalButtons.vue';
+import AGErrorReportModalTitle from './AGErrorReportModalTitle.vue';
+import AGMarkdown from '../basic/AGMarkdown.vue';
+import AGModal from './AGModal.vue';
+
+const props = defineProps(useErrorReportModalProps());
+const activeReportIndex = ref(0);
+const report = computed(() => props.reports[activeReportIndex.value] as ErrorReport);
+</script>

package/src/components/modals/AGErrorReportModalButtons.vue

@@ -0,0 +1,109 @@
+<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() {
+                    (window as { error?: unknown }).error = props.report.error;
+
+                    // eslint-disable-next-line no-console
+                    console.error(props.report.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 '../basic/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.vue

@@ -0,0 +1,19 @@
+<template>
+    <AGModal :cancellable="false">
+        <AGMarkdown :text="renderedMessage" />
+    </AGModal>
+</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 AGMarkdown from '../basic/AGMarkdown.vue';
+
+const props = defineProps({ message: stringProp() });
+const renderedMessage = computed(() => props.message ?? translateWithDefault('ui.loading', 'Loading...'));
+</script>