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

package/histoire.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'histoire';
+import { HstVue } from '@histoire/plugin-vue';
+
+export default defineConfig({
+    setupFile: '/src/main.histoire.ts',
+    plugins: [HstVue()],
+});

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aerogel/core",
     "description": "The Lightest Solid",
-    "version": "0.0.0-next.d824b40e5d06757cd9f47c9f771d916185df4f05",
+    "version": "0.0.0-next.f1f5a990033d966dc0bb12d251110fbc9350dcc7",
     "main": "dist/aerogel-core.cjs.js",
     "module": "dist/aerogel-core.esm.js",
     "types": "dist/aerogel-core.d.ts",
@@ -9,10 +9,12 @@
     "scripts": {
         "build": "rm dist -rf && npm run build:js && npm run build:types",
         "build:js": "noeldemartin-build-javascript",
-        "build:types": "noeldemartin-build-types && cp src/types/virtual.d.ts dist",
+        "build:types": "noeldemartin-build-types",
+        "histoire": "histoire dev",
         "lint": "noeldemartin-lint src",
         "publish-next": "noeldemartin-publish-next",
-        "test": "vitest --run"
+        "test": "vitest --run",
+        "test:ci": "vitest --run --reporter verbose"
     },
     "engines": {
         "node": ">=18.x"
@@ -33,7 +35,7 @@
     },
     "dependencies": {
         "@headlessui/vue": "^1.7.14",
-        "@noeldemartin/utils": "0.4.0-next.2549ce58d5c94a6009ecdd37d6fe2fcd76b6038e",
+        "@noeldemartin/utils": "0.5.0-next.dce7f1ca99862fde01601bb39d71d0eaaed3abe5",
         "dompurify": "^3.0.3",
         "marked": "^5.0.4",
         "pinia": "^2.1.6",
@@ -41,7 +43,14 @@
     },
     "devDependencies": {
         "@aerogel/vite": "*",
+        "@histoire/plugin-vue": "^0.17.6",
         "@types/dompurify": "^3.0.2",
-        "@types/marked": "^5.0.0"
+        "@types/marked": "^5.0.0",
+        "tailwindcss": "^3.3.5"
+    },
+    "eslintConfig": {
+        "extends": [
+            "@noeldemartin/eslint-config-vue"
+        ]
     }
 }

package/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: {
+        tailwindcss: {},
+        autoprefixer: {},
+    },
+};

package/src/assets/histoire.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

package/src/bootstrap/bootstrap.test.ts

@@ -6,11 +6,12 @@ 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', () => {
 
     beforeEach(() => {
+        vi.stubGlobal('document', { getElementById: () => null });
         vi.mock('vue', async () => {
             const vue = (await vi.importActual('vue')) as Object;
 
@@ -31,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;
@@ -45,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,5 +1,5 @@
 import { createApp } from 'vue';
-import type { Component } from 'vue';
+import type { App, Component } from 'vue';
 
 import directives from '@/directives';
 import errors from '@/errors';
@@ -10,12 +10,27 @@ import ui from '@/ui';
 import { installPlugins } from '@/plugins';
 import type { AerogelOptions } from '@/bootstrap/options';
 
-export async function bootstrapApplication(rootComponent: Component, options: AerogelOptions = {}): Promise<void> {
+export { AerogelOptions };
+
+export async function bootstrapApplication(app: App, options: AerogelOptions = {}): Promise<void> {
     const plugins = [directives, errors, lang, services, ui, ...(options.plugins ?? [])];
-    const app = createApp(rootComponent);
 
     await installPlugins(plugins, app, options);
+}
+
+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');
 }
+
+declare module '@/services/Events' {
+    export interface EventsPayload {
+        'application-mounted': void;
+    }
+}

package/src/components/AGAppLayout.vue

@@ -1,11 +1,16 @@
 <template>
-    <div class="flex h-full flex-col text-base font-normal leading-tight text-gray-900 antialiased">
-        <slot />
+    <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">
+            <component :is="$ui.requireComponent(UIComponents.StartupCrash)" />
+        </slot>
+        <slot v-else />
 
         <AGAppOverlays />
     </div>
 </template>
 
 <script setup lang="ts">
+import { UIComponents } from '@/ui/UI';
+
 import AGAppOverlays from './AGAppOverlays.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/AGAppSnackbars.vue

@@ -1,6 +1,6 @@
 <template>
     <div aria-live="assertive" class="z-60 pointer-events-none fixed inset-0 flex items-end px-4 py-6 sm:p-6">
-        <div class="flex w-full flex-col items-center space-y-4 sm:items-end">
+        <div class="flex w-full flex-col items-end space-y-4">
             <component
                 :is="snackbar.component"
                 v-for="snackbar of $ui.snackbars"

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

@@ -0,0 +1,28 @@
+<template>
+    <Story>
+        <div class="h-96">
+            <AGSelect v-model="bestMugiwara" :label="label" :options="options" />
+        </div>
+    </Story>
+</template>
+
+<script setup lang="ts">
+import { ref } from 'vue';
+
+import AGSelect from './AGSelect.vue';
+
+const bestMugiwara = ref(null);
+const label = 'Who\'s the best Mugiwara?';
+const options = [
+    'Monkey D. Luffy',
+    'Roronoa Zoro',
+    'Nami',
+    'Usopp',
+    'Sanji',
+    'Tony Tony Chopper',
+    'Nico Robin',
+    'Franky',
+    'Brook',
+    'Jinbe',
+];
+</script>

package/src/components/forms/AGSelect.vue

@@ -0,0 +1,53 @@
+<template>
+    <AGHeadlessSelect v-bind="props" ref="$select" as="div">
+        <AGHeadlessSelectLabel class="block text-sm font-medium leading-6 text-gray-900" />
+        <div class="relative" :class="{ 'mt-2': $select?.label }">
+            <AGHeadlessSelectButton
+                class="relative w-full cursor-default bg-white py-1.5 pl-3 pr-10 text-left text-gray-900 ring-1 ring-inset ring-gray-300 focus:outline-none focus:ring-2 focus:ring-indigo-600"
+                text-class="block truncate"
+                :class="{
+                    'ring-1 ring-red-500': $select?.errors,
+                }"
+            >
+                <template #icon>
+                    <span class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2">
+                        <IconCheveronDown class="h-5 w-5 text-gray-400" />
+                    </span>
+                </template>
+            </AGHeadlessSelectButton>
+            <AGHeadlessSelectOptions
+                class="absolute z-10 mt-1 max-h-60 w-full overflow-auto border bg-white py-1 text-base ring-1 ring-black ring-opacity-5 focus:outline-none"
+            >
+                <AGHeadlessSelectOption
+                    v-for="(option, index) in $select?.options ?? []"
+                    :key="index"
+                    :value="option.value"
+                    class="relative block cursor-default select-none truncate py-2 pl-3 pr-9"
+                    selected-class="font-semibold"
+                    unselected-class="font-normal"
+                    active-class="bg-indigo-600 text-white"
+                    inactive-class="text-gray-900"
+                />
+            </AGHeadlessSelectOptions>
+        </div>
+        <AGHeadlessSelectError class="mt-2 text-sm text-red-600" />
+    </AGHeadlessSelect>
+</template>
+
+<script setup lang="ts">
+import IconCheveronDown from '~icons/zondicons/cheveron-down';
+
+import { componentRef } from '@/utils/vue';
+import { useSelectProps } from '@/components/headless/forms/AGHeadlessSelect';
+import type { IAGHeadlessSelect } from '@/components/headless/forms/AGHeadlessSelect';
+
+import AGHeadlessSelect from '../headless/forms/AGHeadlessSelect.vue';
+import AGHeadlessSelectButton from '../headless/forms/AGHeadlessSelectButton.vue';
+import AGHeadlessSelectError from '../headless/forms/AGHeadlessSelectError.vue';
+import AGHeadlessSelectLabel from '../headless/forms/AGHeadlessSelectLabel.vue';
+import AGHeadlessSelectOption from '../headless/forms/AGHeadlessSelectOption.vue';
+import AGHeadlessSelectOptions from '../headless/forms/AGHeadlessSelectOptions';
+
+const props = defineProps(useSelectProps());
+const $select = componentRef<IAGHeadlessSelect>();
+</script>

package/src/components/forms/index.ts

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

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

@@ -1,8 +1,28 @@
-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>;
     value: ComputedRef<string | number | boolean | null>;
     errors: DeepReadonly<Ref<string[] | null>>;
     update(value: string | number | boolean | null): void;
 }
+
+export const inputProps = {
+    name: stringProp(),
+    label: stringProp(),
+};
+
+export function useInputProps(): typeof inputProps {
+    return inputProps;
+}
+
+export function extractInputProps<T extends ExtractPropTypes<typeof inputProps>>(
+    props: T,
+): Pick<T, keyof typeof inputProps> {
+    return extractComponentProps(props, inputProps);
+}

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

@@ -12,13 +12,14 @@ import { uuid } from '@noeldemartin/utils';
 import { mixedProp, stringProp } from '@/utils/vue';
 import type Form from '@/forms/Form';
 
+import { useInputProps } from './AGHeadlessInput';
 import type { IAGHeadlessInput } from './AGHeadlessInput';
 
 const emit = defineEmits(['update:modelValue']);
 const props = defineProps({
     as: stringProp('div'),
-    name: stringProp(),
     modelValue: mixedProp<string | number | boolean>([String, Number, Boolean]),
+    ...useInputProps(),
 });
 const errors = computed(() => {
     if (!form || !props.name) {
@@ -28,11 +29,13 @@ const errors = computed(() => {
     return form.errors[props.name] ?? null;
 });
 const form = inject<Form | null>('form', null);
-const publicApi: IAGHeadlessInput = {
+const api: IAGHeadlessInput = {
     id: `input-${uuid()}`,
+    name: computed(() => props.name),
+    label: computed(() => props.label),
     value: computed(() => {
         if (form && props.name) {
-            return form.getFieldValue(props.name);
+            return form.getFieldValue(props.name) as string | number | boolean | null;
         }
 
         return props.modelValue;
@@ -49,6 +52,6 @@ const publicApi: IAGHeadlessInput = {
     },
 };
 
-provide<IAGHeadlessInput>('input', publicApi);
-defineExpose<IAGHeadlessInput>(publicApi);
+provide<IAGHeadlessInput>('input', api);
+defineExpose<IAGHeadlessInput>(api);
 </script>

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

@@ -1,10 +1,14 @@
 <template>
-    <label :for="input.id">
-        <slot />
+    <label v-if="show" :for="input.id">
+        <slot>
+            {{ input.label }}
+        </slot>
     </label>
 </template>
 
 <script setup lang="ts">
+import { computed, useSlots } from 'vue';
+
 import { injectReactiveOrFail } from '@/utils/vue';
 
 import type { IAGHeadlessInput } from './AGHeadlessInput';
@@ -13,4 +17,6 @@ const input = injectReactiveOrFail<IAGHeadlessInput>(
     'input',
     '<AGHeadlessInputLabel> must be a child of a <AGHeadlessInput>',
 );
+const slots = useSlots();
+const show = computed(() => !!(input.label || slots.default));
 </script>

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

@@ -0,0 +1,39 @@
+import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
+
+import { requiredArrayProp, stringProp } from '@/utils/vue';
+import { extractComponentProps } from '@/components/utils';
+
+export interface IAGSelectOption {
+    value: string | number | boolean | object | null;
+    text: string;
+}
+
+export type IAGSelectOptionValue = string | number | boolean | object | null;
+
+export interface IAGHeadlessSelect {
+    id: string;
+    label: ComputedRef<string | null>;
+    noSelectionText: ComputedRef<string>;
+    buttonText: ComputedRef<string>;
+    selectedOption: ComputedRef<IAGSelectOption | undefined>;
+    options: ComputedRef<IAGSelectOption[]>;
+    errors: DeepReadonly<Ref<string[] | null>>;
+    update(value: IAGSelectOptionValue): void;
+}
+
+export const selectProps = {
+    name: stringProp(),
+    label: stringProp(),
+    options: requiredArrayProp<IAGSelectOptionValue>(),
+    noSelectionText: stringProp(),
+};
+
+export function useSelectProps(): typeof selectProps {
+    return 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

@@ -0,0 +1,76 @@
+<template>
+    <Listbox
+        v-slot="{ value, open, disabled }: ComponentProps"
+        :model-value="selectedOption?.value"
+        @update:model-value="update($event)"
+    >
+        <slot :value="value" :open="open" :disabled="disabled" />
+    </Listbox>
+</template>
+
+<script setup lang="ts">
+import { computed, inject, provide } from 'vue';
+import { isObject, 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 { ComponentProps } from '@/utils/vue';
+
+import { useSelectProps } from './AGHeadlessSelect';
+import type { IAGHeadlessSelect, IAGSelectOption, IAGSelectOptionValue } from './AGHeadlessSelect';
+
+const emit = defineEmits(['update:modelValue']);
+const props = defineProps({
+    modelValue: mixedProp<IAGSelectOptionValue>(),
+    ...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),
+        };
+
+        return option;
+    }));
+const selectedOption = computed(() => {
+    const selectedOptionValue = form && props.name ? form.getFieldValue(props.name) : props.modelValue;
+
+    return options.value.find((option) => option.value === selectedOptionValue);
+});
+const errors = computed(() => {
+    if (!form || !props.name) {
+        return null;
+    }
+
+    return form.errors[props.name] ?? null;
+});
+
+function update(value: IAGSelectOptionValue) {
+    if (form && props.name) {
+        form.setFieldValue(props.name, value);
+
+        return;
+    }
+
+    emit('update:modelValue', value);
+}
+
+const api: IAGHeadlessSelect = {
+    id: `select-${uuid()}`,
+    options,
+    noSelectionText,
+    selectedOption,
+    errors,
+    label: computed(() => props.label),
+    buttonText: computed(() => selectedOption.value?.text ?? noSelectionText.value),
+    update,
+};
+
+provide<IAGHeadlessSelect>('select', api);
+defineExpose<IAGHeadlessSelect>(api);
+</script>

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

@@ -0,0 +1,24 @@
+<template>
+    <ListboxButton v-slot="{ value, open, disabled }: ComponentProps">
+        <slot :value="value" :open="open" :disabled="disabled">
+            <span :class="textClass">{{ select?.buttonText }}</span>
+        </slot>
+        <slot name="icon" />
+    </ListboxButton>
+</template>
+
+<script setup lang="ts">
+import { ListboxButton } from '@headlessui/vue';
+
+import { injectReactiveOrFail, stringProp } from '@/utils/vue';
+import type { ComponentProps } from '@/utils/vue';
+
+import type { IAGHeadlessSelect } from './AGHeadlessSelect';
+
+defineProps({ textClass: stringProp() });
+
+const select = injectReactiveOrFail<IAGHeadlessSelect>(
+    'select',
+    '<AGHeadlessSelectButton> must be a child of a <AGHeadlessSelect>',
+);
+</script>

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

@@ -0,0 +1,26 @@
+<template>
+    <p v-if="errorMessage" :id="`${select.id}-error`">
+        {{ errorMessage }}
+    </p>
+</template>
+
+<script setup lang="ts">
+import { computed } from 'vue';
+
+import { injectReactiveOrFail } from '@/utils/vue';
+import { translateWithDefault } from '@/lang/utils';
+
+import type { IAGHeadlessSelect } from './AGHeadlessSelect';
+
+const select = injectReactiveOrFail<IAGHeadlessSelect>(
+    'select',
+    '<AGHeadlessSelectError> must be a child of a <AGHeadlessSelect>',
+);
+const errorMessage = computed(() => {
+    if (!select.errors) {
+        return null;
+    }
+
+    return translateWithDefault(`errors.${select.errors[0]}`, `Error: ${select.errors[0]}`);
+});
+</script>

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

@@ -0,0 +1,24 @@
+<template>
+    <ListboxLabel v-if="show" v-slot="{ open, disabled }: ComponentProps">
+        <slot :open="open" :disabled="disabled">
+            {{ select.label }}
+        </slot>
+    </ListboxLabel>
+</template>
+
+<script setup lang="ts">
+import { computed, useSlots } from 'vue';
+import { ListboxLabel } from '@headlessui/vue';
+
+import { injectReactiveOrFail } from '@/utils/vue';
+import type { ComponentProps } from '@/utils/vue';
+
+import type { IAGHeadlessSelect } from './AGHeadlessSelect';
+
+const select = injectReactiveOrFail<IAGHeadlessSelect>(
+    'select',
+    '<AGHeadlessSelectLabel> must be a child of a <AGHeadlessSelect>',
+);
+const slots = useSlots();
+const show = computed(() => !!(select.label || slots.default));
+</script>

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

@@ -0,0 +1,4 @@
+export type IAGHeadlessSelectOptionSlotProps = {
+    active: boolean;
+    selected: boolean;
+};

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

@@ -0,0 +1,39 @@
+<template>
+    <ListboxOption v-slot="{ active, selected, disabled }: ComponentProps" :value="value" as="template">
+        <slot :active="active" :selected="selected" :disabled="disabled">
+            <li
+                :class="{
+                    [activeClass ?? 'active']: active,
+                    [inactiveClass ?? 'inactive']: !active,
+                    [selectedClass ?? 'selected']: selected,
+                    [unselectedClass ?? 'unselected']: !selected,
+                }"
+            >
+                {{ option?.text }}
+            </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 { IAGHeadlessSelect, IAGSelectOptionValue } from './AGHeadlessSelect';
+
+const props = defineProps({
+    value: requiredMixedProp<IAGSelectOptionValue>(),
+    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/AGHeadlessSelectOptions.ts

@@ -0,0 +1,3 @@
+import { ListboxOptions } from '@headlessui/vue';
+
+export default ListboxOptions;

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

@@ -1,6 +1,14 @@
-export { IAGHeadlessInput } from './AGHeadlessInput';
+export * from './AGHeadlessInput';
+export * from './AGHeadlessSelect';
+export * from './AGHeadlessSelectOption';
 export { default as AGHeadlessButton } from './AGHeadlessButton.vue';
 export { default as AGHeadlessInput } from './AGHeadlessInput.vue';
 export { default as AGHeadlessInputError } from './AGHeadlessInputError.vue';
 export { default as AGHeadlessInputInput } from './AGHeadlessInputInput.vue';
 export { default as AGHeadlessInputLabel } from './AGHeadlessInputLabel.vue';
+export { default as AGHeadlessSelect } from './AGHeadlessSelect.vue';
+export { default as AGHeadlessSelectButton } from './AGHeadlessSelectButton.vue';
+export { default as AGHeadlessSelectError } from './AGHeadlessSelectError.vue';
+export { default as AGHeadlessSelectLabel } from './AGHeadlessSelectLabel.vue';
+export { default as AGHeadlessSelectOption } from './AGHeadlessSelectOption.vue';
+export { default as AGHeadlessSelectOptions } from './AGHeadlessSelectOptions';