@aerogel/core 0.0.0-next.980a397d575dcb5ff8c5a0bff769d09f938ea03c → 0.0.0-next.a3194a101ceda87a7033fa5e283e046bad6f4bfc

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aerogel/core",
     "description": "The Lightest Solid",
-    "version": "0.0.0-next.980a397d575dcb5ff8c5a0bff769d09f938ea03c",
+    "version": "0.0.0-next.a3194a101ceda87a7033fa5e283e046bad6f4bfc",
     "main": "dist/aerogel-core.cjs.js",
     "module": "dist/aerogel-core.esm.js",
     "types": "dist/aerogel-core.d.ts",
@@ -35,7 +35,7 @@
     },
     "dependencies": {
         "@headlessui/vue": "^1.7.14",
-        "@noeldemartin/utils": "0.5.0-next.dce7f1ca99862fde01601bb39d71d0eaaed3abe5",
+        "@noeldemartin/utils": "0.5.1-next.49cc6c9b4a20930cbf922a949135981791acc5c3",
         "dompurify": "^3.0.3",
         "marked": "^5.0.4",
         "pinia": "^2.1.6",

package/src/bootstrap/bootstrap.test.ts

@@ -6,7 +6,7 @@ import type { Component } from 'vue';
 import Events from '@/services/Events';
 import initialFocus from '@/directives/initial-focus';
 
-import { bootstrapApplication } from './index';
+import { bootstrap } from './index';
 
 describe('Aerogel', () => {
 
@@ -32,7 +32,7 @@ describe('Aerogel', () => {
         const rootComponent = mock<Component>();
 
         // Act
-        await bootstrapApplication(rootComponent);
+        await bootstrap(rootComponent);
 
         // Assert
         const globals = vi.mocked(createApp).mock.results[0]?.value.config.globalProperties;
@@ -46,7 +46,7 @@ describe('Aerogel', () => {
         const rootComponent = mock<Component>();
 
         // Act
-        await bootstrapApplication(rootComponent);
+        await bootstrap(rootComponent);
 
         // Assert
         expect(vi.mocked(createApp).mock.results[0]?.value.directive).toHaveBeenCalledWith(

package/src/bootstrap/index.ts

@@ -1,29 +1,40 @@
 import { createApp } from 'vue';
-import type { Component } from 'vue';
+import type { App, Component } from 'vue';
 
 import directives from '@/directives';
 import errors from '@/errors';
 import Events from '@/services/Events';
 import lang from '@/lang';
 import services from '@/services';
+import testing from '@/testing';
 import ui from '@/ui';
 import { installPlugins } from '@/plugins';
 import type { AerogelOptions } from '@/bootstrap/options';
 
-export async function bootstrapApplication(rootComponent: Component, options: AerogelOptions = {}): Promise<void> {
-    const plugins = [directives, errors, lang, services, ui, ...(options.plugins ?? [])];
-    const app = createApp(rootComponent);
+export { AerogelOptions };
+
+export async function bootstrapApplication(app: App, options: AerogelOptions = {}): Promise<void> {
+    const plugins = [testing, directives, errors, lang, services, ui, ...(options.plugins ?? [])];
 
     await installPlugins(plugins, app, options);
+    await options.install?.(app);
+    await Events.emit('application-ready');
+}
+
+export async function bootstrap(rootComponent: Component, options: AerogelOptions = {}): Promise<void> {
+    const app = createApp(rootComponent);
+
+    await bootstrapApplication(app, options);
 
     app.mount('#app');
     app._container?.classList.remove('loading');
 
-    Events.emit('application-mounted');
+    await Events.emit('application-mounted');
 }
 
 declare module '@/services/Events' {
     export interface EventsPayload {
+        'application-ready': void;
         'application-mounted': void;
     }
 }

package/src/bootstrap/options.ts

@@ -1,5 +1,8 @@
+import type { App } from 'vue';
+
 import type { Plugin } from '@/plugins';
 
 export interface AerogelOptions {
     plugins?: Plugin[];
+    install?(app: App): void | Promise<void>;
 }

package/src/components/AGAppLayout.vue

@@ -1,7 +1,7 @@
 <template>
     <div class="flex min-h-full flex-col text-base font-normal leading-tight text-gray-900 antialiased">
         <slot v-if="$errors.hasStartupErrors" name="startup-crash">
-            <AGStartupCrash />
+            <component :is="$ui.requireComponent(UIComponents.StartupCrash)" />
         </slot>
         <slot v-else />
 
@@ -10,6 +10,7 @@
 </template>
 
 <script setup lang="ts">
+import { UIComponents } from '@/ui/UI';
+
 import AGAppOverlays from './AGAppOverlays.vue';
-import AGStartupCrash from './lib/AGStartupCrash.vue';
 </script>

package/src/components/AGAppOverlays.vue

@@ -1,5 +1,9 @@
 <template>
-    <div ref="$backdrop" class="pointer-events-none fixed inset-0 z-50 bg-black/30 opacity-0" />
+    <div
+        id="aerogel-overlays-backdrop"
+        ref="$backdrop"
+        class="pointer-events-none fixed inset-0 z-50 bg-black/30 opacity-0"
+    />
     <AGAppModals />
     <AGAppSnackbars />
 </template>

package/src/components/forms/AGCheckbox.vue

@@ -1,5 +1,10 @@
 <template>
-    <AGHeadlessInput ref="$input" :name="name" class="flex">
+    <AGHeadlessInput
+        ref="$input"
+        :name="name"
+        class="flex"
+        @update:model-value="$emit('update:modelValue', $event)"
+    >
         <AGHeadlessInputInput
             v-bind="$attrs"
             type="checkbox"
@@ -30,6 +35,7 @@ import AGHeadlessInputLabel from '../headless/forms/AGHeadlessInputLabel.vue';
 
 defineProps({ name: stringProp() });
 defineOptions({ inheritAttrs: false });
+defineEmits(['update:modelValue']);
 
 const $input = componentRef<IAGHeadlessInput>();
 </script>

package/src/components/forms/AGInput.vue

@@ -3,8 +3,9 @@
         ref="$input"
         class="relative flex flex-col items-center"
         :class="className"
-        :name="name"
+        v-bind="props"
     >
+        <AGHeadlessInputLabel class="sr-only" />
         <AGHeadlessInputInput
             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"
@@ -12,6 +13,7 @@
                 'ring-1 ring-red-500': $input?.errors,
             }"
         />
+        <AGHeadlessInputDescription />
         <div class="absolute bottom-0 left-0 translate-y-full">
             <AGHeadlessInputError class="mt-1 text-sm text-red-500" />
         </div>
@@ -19,18 +21,20 @@
 </template>
 
 <script setup lang="ts">
-import { componentRef, stringProp } from '@/utils/vue';
-
-import { useInputAttrs } from '@/utils';
+import { componentRef } from '@/utils/vue';
+import { useInputAttrs } from '@/utils/composition/forms';
+import { useInputProps } from '@/components/headless/forms/AGHeadlessInput';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
 import AGHeadlessInput from '../headless/forms/AGHeadlessInput.vue';
-import AGHeadlessInputInput from '../headless/forms/AGHeadlessInputInput.vue';
+import AGHeadlessInputDescription from '../headless/forms/AGHeadlessInputDescription.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 props = defineProps(useInputProps());
 const $input = componentRef<IAGHeadlessInput>();
 const [attrs, className] = useInputAttrs();
 </script>

package/src/components/forms/AGSelect.story.vue

@@ -1,7 +1,13 @@
 <template>
     <Story>
         <div class="h-96">
-            <AGSelect v-model="bestMugiwara" :label="label" :options="options" />
+            <AGSelect v-model="bestMugiwara" :label="bestMugiwaraLabel" :options="bestMugiwaraOptions" />
+            <AGSelect
+                v-model="bestFood"
+                :label="bestFoodLabel"
+                :options="bestFoodOptions"
+                options-text="name"
+            />
         </div>
     </Story>
 </template>
@@ -12,8 +18,10 @@ import { ref } from 'vue';
 import AGSelect from './AGSelect.vue';
 
 const bestMugiwara = ref(null);
-const label = 'Who\'s the best Mugiwara?';
-const options = [
+const bestFood = ref(null);
+const bestMugiwaraLabel = 'Who\'s the best Mugiwara?';
+const bestFoodLabel = 'What\'s the best food?';
+const bestMugiwaraOptions = [
     'Monkey D. Luffy',
     'Roronoa Zoro',
     'Nami',
@@ -25,4 +33,14 @@ const options = [
     'Brook',
     'Jinbe',
 ];
+const bestFoodOptions = [
+    {
+        id: 'ramen',
+        name: 'Ramen',
+    },
+    {
+        id: 'pizza',
+        name: 'Pizza',
+    },
+];
 </script>

package/src/components/forms/AGSelect.vue

@@ -1,5 +1,10 @@
 <template>
-    <AGHeadlessSelect v-bind="props" ref="$select" as="div">
+    <AGHeadlessSelect
+        v-bind="props"
+        ref="$select"
+        as="div"
+        @update:model-value="$emit('update:modelValue', $event)"
+    >
         <AGHeadlessSelectLabel class="block text-sm font-medium leading-6 text-gray-900" />
         <div class="relative" :class="{ 'mt-2': $select?.label }">
             <AGHeadlessSelectButton
@@ -21,7 +26,7 @@
                 <AGHeadlessSelectOption
                     v-for="(option, index) in $select?.options ?? []"
                     :key="index"
-                    :value="option.value"
+                    :value="option"
                     class="relative block cursor-default select-none truncate py-2 pl-3 pr-9"
                     selected-class="font-semibold"
                     unselected-class="font-normal"
@@ -38,7 +43,7 @@
 import IconCheveronDown from '~icons/zondicons/cheveron-down';
 
 import { componentRef } from '@/utils/vue';
-import { useSelectProps } from '@/components/headless/forms/AGHeadlessSelect';
+import { useSelectEmits, useSelectProps } from '@/components/headless/forms/AGHeadlessSelect';
 import type { IAGHeadlessSelect } from '@/components/headless/forms/AGHeadlessSelect';
 
 import AGHeadlessSelect from '../headless/forms/AGHeadlessSelect.vue';
@@ -48,6 +53,8 @@ import AGHeadlessSelectLabel from '../headless/forms/AGHeadlessSelectLabel.vue';
 import AGHeadlessSelectOption from '../headless/forms/AGHeadlessSelectOption.vue';
 import AGHeadlessSelectOptions from '../headless/forms/AGHeadlessSelectOptions';
 
+defineEmits(useSelectEmits());
+
 const props = defineProps(useSelectProps());
 const $select = componentRef<IAGHeadlessSelect>();
 </script>

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

@@ -10,7 +10,7 @@ import { objectWithoutEmpty } from '@noeldemartin/utils';
 
 import { booleanProp, objectProp, stringProp } from '@/utils/vue';
 
-const { href, url, route, routeParams, routeQuery, submit } = defineProps({
+const props = defineProps({
     href: stringProp(),
     url: stringProp(),
     route: stringProp(),
@@ -20,32 +20,32 @@ const { href, url, route, routeParams, routeQuery, submit } = defineProps({
 });
 
 const component = computed(() => {
-    if (route) {
+    if (props.route) {
         return {
             tag: 'router-link',
             props: {
                 to: objectWithoutEmpty({
-                    name: route,
-                    params: routeParams,
-                    query: routeQuery,
+                    name: props.route,
+                    params: props.routeParams,
+                    query: props.routeQuery,
                 }),
             },
         };
     }
 
-    if (href || url) {
+    if (props.href || props.url) {
         return {
             tag: 'a',
             props: {
                 target: '_blank',
-                href: href || url,
+                href: props.href || props.url,
             },
         };
     }
 
     return {
         tag: 'button',
-        props: { type: submit ? 'submit' : 'button' },
+        props: { type: props.submit ? 'submit' : 'button' },
     };
 });
 </script>

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

@@ -1,11 +1,13 @@
-import type { ComputedRef, DeepReadonly, Ref } from 'vue';
+import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
 
 import { stringProp } from '@/utils';
+import { extractComponentProps } from '@/components/utils';
 
 export interface IAGHeadlessInput {
     id: string;
     name: ComputedRef<string | null>;
     label: ComputedRef<string | null>;
+    description: ComputedRef<string | boolean | null>;
     value: ComputedRef<string | number | boolean | null>;
     errors: DeepReadonly<Ref<string[] | null>>;
     update(value: string | number | boolean | null): void;
@@ -14,20 +16,15 @@ export interface IAGHeadlessInput {
 export const inputProps = {
     name: stringProp(),
     label: stringProp(),
+    description: stringProp(),
 };
 
 export function useInputProps(): typeof inputProps {
     return inputProps;
 }
 
-export function extractInputProps<T extends Record<keyof typeof inputProps, unknown>>(
-    componentProps: T,
+export function extractInputProps<T extends ExtractPropTypes<typeof inputProps>>(
+    props: T,
 ): Pick<T, keyof typeof inputProps> {
-    return Object.keys(inputProps).reduce((extractedProps, selectProp) => {
-        const prop = selectProp as keyof typeof inputProps;
-
-        extractedProps[prop] = componentProps[prop];
-
-        return extractedProps;
-    }, {} as Pick<T, keyof typeof inputProps>);
+    return extractComponentProps(props, inputProps);
 }

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

@@ -33,6 +33,7 @@ const api: IAGHeadlessInput = {
     id: `input-${uuid()}`,
     name: computed(() => props.name),
     label: computed(() => props.label),
+    description: computed(() => props.description),
     value: computed(() => {
         if (form && props.name) {
             return form.getFieldValue(props.name) as string | number | boolean | null;

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

@@ -0,0 +1,28 @@
+<template>
+    <slot :id="`${input.id}-description`">
+        <AGMarkdown
+            v-if="show"
+            v-bind="$attrs"
+            :id="`${input.id}-description`"
+            :text="text"
+        />
+    </slot>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import { injectReactiveOrFail } from '@/utils/vue';
+
+import AGMarkdown from '../../lib/AGMarkdown.vue';
+import type { IAGHeadlessInput } from './AGHeadlessInput';
+
+defineOptions({ inheritAttrs: false });
+
+const input = injectReactiveOrFail<IAGHeadlessInput>(
+    'input',
+    '<AGHeadlessInputDescription> must be a child of a <AGHeadlessInput>',
+);
+const text = computed(() => (typeof input.description === 'string' ? input.description : ''));
+const show = computed(() => !!input.description);
+</script>

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

@@ -2,10 +2,13 @@
     <input
         :id="input.id"
         ref="$input"
+        :name="name"
         :type="type"
         :value="value"
         :aria-invalid="input.errors ? 'true' : 'false'"
-        :aria-describedby="input.errors ? `${input.id}-error` : undefined"
+        :aria-describedby="
+            input.errors ? `${input.id}-error` : input.description ? `${input.id}-description` : undefined
+        "
         :checked="checked"
         @input="update"
     >
@@ -26,6 +29,7 @@ const input = injectReactiveOrFail<IAGHeadlessInput>(
     'input',
     '<AGHeadlessInputInput> must be a child of a <AGHeadlessInput>',
 );
+const name = computed(() => input.name ?? undefined);
 const value = computed(() => input.value);
 const checked = computed(() => {
     if (props.type !== 'checkbox') {

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

@@ -1,44 +1,42 @@
-import type { ComputedRef, DeepReadonly, Ref } from 'vue';
+import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
+import type { Writable } from '@noeldemartin/utils';
 
-import { requiredArrayProp, stringProp } from '@/utils/vue';
-
-export interface IAGSelectOption {
-    value: string | number | boolean | object | null;
-    text: string;
-}
-
-export type IAGSelectOptionValue = string | number | boolean | object | null;
+import { mixedProp, requiredArrayProp, stringProp } from '@/utils/vue';
+import { extractComponentProps } from '@/components/utils';
+import type { FormFieldValue } from '@/forms/Form';
 
 export interface IAGHeadlessSelect {
     id: string;
     label: ComputedRef<string | null>;
     noSelectionText: ComputedRef<string>;
     buttonText: ComputedRef<string>;
-    selectedOption: ComputedRef<IAGSelectOption | undefined>;
-    options: ComputedRef<IAGSelectOption[]>;
+    renderText: ComputedRef<(value: FormFieldValue) => string>;
+    selectedOption: ComputedRef<FormFieldValue | null>;
+    options: ComputedRef<FormFieldValue[]>;
     errors: DeepReadonly<Ref<string[] | null>>;
-    update(value: IAGSelectOptionValue): void;
+    update(value: FormFieldValue): void;
 }
 
 export const selectProps = {
     name: stringProp(),
     label: stringProp(),
-    options: requiredArrayProp<IAGSelectOptionValue>(),
+    options: requiredArrayProp<FormFieldValue>(),
     noSelectionText: stringProp(),
+    optionsText: mixedProp<string | ((option: FormFieldValue) => string)>(),
 };
 
+export const selectEmits = ['update:modelValue'] as const;
+
 export function useSelectProps(): typeof selectProps {
     return selectProps;
 }
 
-export function extractSelectProps<T extends Record<keyof typeof selectProps, unknown>>(
-    componentProps: T,
-): Pick<T, keyof typeof selectProps> {
-    return Object.keys(selectProps).reduce((extractedProps, selectProp) => {
-        const prop = selectProp as keyof typeof selectProps;
-
-        extractedProps[prop] = componentProps[prop];
+export function useSelectEmits(): Writable<typeof selectEmits> {
+    return [...selectEmits];
+}
 
-        return extractedProps;
-    }, {} as Pick<T, keyof typeof selectProps>);
+export function extractSelectProps<T extends ExtractPropTypes<typeof selectProps>>(
+    props: T,
+): Pick<T, keyof typeof selectProps> {
+    return extractComponentProps(props, selectProps);
 }

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

@@ -1,7 +1,7 @@
 <template>
     <Listbox
         v-slot="{ value, open, disabled }: ComponentProps"
-        :model-value="selectedOption?.value"
+        :model-value="selectedOption"
         @update:model-value="update($event)"
     >
         <slot :value="value" :open="open" :disabled="disabled" />
@@ -10,38 +10,37 @@
 
 <script setup lang="ts">
 import { computed, inject, provide } from 'vue';
-import { isObject, toString, uuid } from '@noeldemartin/utils';
+import { toString, uuid } from '@noeldemartin/utils';
 import { Listbox } from '@headlessui/vue';
 
 import { mixedProp } from '@/utils/vue';
 import { translateWithDefault } from '@/lang/utils';
 import type Form from '@/forms/Form';
+import type { FormFieldValue } from '@/forms/Form';
 import type { ComponentProps } from '@/utils/vue';
 
-import { useSelectProps } from './AGHeadlessSelect';
-import type { IAGHeadlessSelect, IAGSelectOption, IAGSelectOptionValue } from './AGHeadlessSelect';
+import { useSelectEmits, useSelectProps } from './AGHeadlessSelect';
+import type { IAGHeadlessSelect } from './AGHeadlessSelect';
 
-const emit = defineEmits(['update:modelValue']);
+const emit = defineEmits(useSelectEmits());
 const props = defineProps({
-    modelValue: mixedProp<IAGSelectOptionValue>(),
+    modelValue: mixedProp<FormFieldValue>(),
     ...useSelectProps(),
 });
-const form = inject<Form | null>('form', null);
-const noSelectionText = computed(() => props.noSelectionText ?? translateWithDefault('select.noSelection', '-'));
-const options = computed(() =>
-    props.options.map((value) => {
-        const option: IAGSelectOption = {
-            value,
-            text: toString(isObject(value) && 'text' in value ? value.text : value),
-        };
+const renderText = computed(() => {
+    if (typeof props.optionsText === 'function') {
+        return props.optionsText;
+    }
 
-        return option;
-    }));
-const selectedOption = computed(() => {
-    const selectedOptionValue = form && props.name ? form.getFieldValue(props.name) : props.modelValue;
+    if (typeof props.optionsText === 'string') {
+        return (option: FormFieldValue): string => toString(option[props.optionsText as keyof FormFieldValue]);
+    }
 
-    return options.value.find((option) => option.value === selectedOptionValue);
+    return (option: FormFieldValue) => toString(option);
 });
+const form = inject<Form | null>('form', null);
+const noSelectionText = computed(() => props.noSelectionText ?? translateWithDefault('select.noSelection', '-'));
+const selectedOption = computed(() => (form && props.name ? form.getFieldValue(props.name) : props.modelValue));
 const errors = computed(() => {
     if (!form || !props.name) {
         return null;
@@ -50,7 +49,7 @@ const errors = computed(() => {
     return form.errors[props.name] ?? null;
 });
 
-function update(value: IAGSelectOptionValue) {
+function update(value: FormFieldValue) {
     if (form && props.name) {
         form.setFieldValue(props.name, value);
 
@@ -62,12 +61,14 @@ function update(value: IAGSelectOptionValue) {
 
 const api: IAGHeadlessSelect = {
     id: `select-${uuid()}`,
-    options,
     noSelectionText,
     selectedOption,
     errors,
+    options: computed(() => props.options),
     label: computed(() => props.label),
-    buttonText: computed(() => selectedOption.value?.text ?? noSelectionText.value),
+    buttonText: computed(() =>
+        selectedOption.value === null ? noSelectionText.value : renderText.value(selectedOption.value)),
+    renderText,
     update,
 };
 

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

@@ -9,31 +9,31 @@
                     [unselectedClass ?? 'unselected']: !selected,
                 }"
             >
-                {{ option?.text }}
+                {{ select.renderText(value) }}
             </li>
         </slot>
     </ListboxOption>
 </template>
 
 <script setup lang="ts">
-import { computed } from 'vue';
 import { ListboxOption } from '@headlessui/vue';
 
 import { injectReactiveOrFail, requiredMixedProp, stringProp } from '@/utils/vue';
 import type { ComponentProps } from '@/utils/vue';
+import type { FormFieldValue } from '@/forms/Form';
 
-import type { IAGHeadlessSelect, IAGSelectOptionValue } from './AGHeadlessSelect';
+import type { IAGHeadlessSelect } from './AGHeadlessSelect';
 
-const props = defineProps({
-    value: requiredMixedProp<IAGSelectOptionValue>(),
+defineProps({
+    value: requiredMixedProp<FormFieldValue>(),
     selectedClass: stringProp(),
     unselectedClass: stringProp(),
     activeClass: stringProp(),
     inactiveClass: stringProp(),
 });
+
 const select = injectReactiveOrFail<IAGHeadlessSelect>(
     'select',
     '<AGHeadlessSelectOption> must be a child of a <AGHeadlessSelect>',
 );
-const option = computed(() => select.options.find((selectOption) => selectOption.value === props.value));
 </script>

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

@@ -3,6 +3,7 @@ export * from './AGHeadlessSelect';
 export * from './AGHeadlessSelectOption';
 export { default as AGHeadlessButton } from './AGHeadlessButton.vue';
 export { default as AGHeadlessInput } from './AGHeadlessInput.vue';
+export { default as AGHeadlessInputDescription } from './AGHeadlessInputDescription.vue';
 export { default as AGHeadlessInputError } from './AGHeadlessInputError.vue';
 export { default as AGHeadlessInputInput } from './AGHeadlessInputInput.vue';
 export { default as AGHeadlessInputLabel } from './AGHeadlessInputLabel.vue';