@aerogel/core 0.0.0-next.f8cdd39997c56dcd46e07c26af8a84d04d610fce → 0.0.0-next.fd1bd21aea7a9ab8c4eab69a5f5776db5de8bf35

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.f8cdd39997c56dcd46e07c26af8a84d04d610fce",
+    "version": "0.0.0-next.fd1bd21aea7a9ab8c4eab69a5f5776db5de8bf35",
     "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.ac00beaecf32bb02ed8e335225d7948d946d73bd",
+        "@noeldemartin/utils": "0.5.1-next.49cc6c9b4a20930cbf922a949135981791acc5c3",
         "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,20 +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 ?? [])];
+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 Promise.all(plugins.map((plugin) => plugin.install(app, options)) ?? []);
+    await bootstrapApplication(app, options);
 
     app.mount('#app');
-    Events.emit('application-mounted');
+    app._container?.classList.remove('loading');
+
+    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,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/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/AGForm.vue

@@ -1,26 +1,25 @@
 <template>
-    <form @submit.prevent="submit">
+    <form @submit.prevent="form?.submit()">
         <slot />
     </form>
 </template>
 
 <script setup lang="ts">
-import { provide } from 'vue';
+import { provide, watchEffect } from 'vue';
 
 import { objectProp } from '@/utils/vue';
 import type Form from '@/forms/Form';
 
+let offSubmit: (() => void) | undefined;
 const props = defineProps({ form: objectProp<Form>() });
-
 const emit = defineEmits<{ submit: [] }>();
 
-provide('form', props.form);
+watchEffect((onCleanup) => {
+    offSubmit?.();
+    offSubmit = props.form?.on('submit', () => emit('submit'));
 
-function submit() {
-    if (props.form && !props.form.submit()) {
-        return;
-    }
+    onCleanup(() => offSubmit?.());
+});
 
-    emit('submit');
-}
+provide('form', props.form);
 </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

@@ -0,0 +1,46 @@
+<template>
+    <Story>
+        <div class="h-96">
+            <AGSelect v-model="bestMugiwara" :label="bestMugiwaraLabel" :options="bestMugiwaraOptions" />
+            <AGSelect
+                v-model="bestFood"
+                :label="bestFoodLabel"
+                :options="bestFoodOptions"
+                options-text="name"
+            />
+        </div>
+    </Story>
+</template>
+
+<script setup lang="ts">
+import { ref } from 'vue';
+
+import AGSelect from './AGSelect.vue';
+
+const bestMugiwara = ref(null);
+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',
+    'Usopp',
+    'Sanji',
+    'Tony Tony Chopper',
+    'Nico Robin',
+    'Franky',
+    'Brook',
+    'Jinbe',
+];
+const bestFoodOptions = [
+    {
+        id: 'ramen',
+        name: 'Ramen',
+    },
+    {
+        id: 'pizza',
+        name: 'Pizza',
+    },
+];
+</script>

package/src/components/forms/AGSelect.vue

@@ -0,0 +1,60 @@
+<template>
+    <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
+                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"
+                    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 { useSelectEmits, 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';
+
+defineEmits(useSelectEmits());
+
+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/AGHeadlessButton.vue

@@ -1,5 +1,5 @@
 <template>
-    <component :is="component.tag" v-bind="component.props">
+    <component :is="component.as" v-bind="component.props">
         <slot />
     </component>
 </template>
@@ -10,7 +10,8 @@ import { objectWithoutEmpty } from '@noeldemartin/utils';
 
 import { booleanProp, objectProp, stringProp } from '@/utils/vue';
 
-const { href, url, route, routeParams, routeQuery, submit } = defineProps({
+const props = defineProps({
+    as: objectProp(),
     href: stringProp(),
     url: stringProp(),
     route: stringProp(),
@@ -20,32 +21,36 @@ const { href, url, route, routeParams, routeQuery, submit } = defineProps({
 });
 
 const component = computed(() => {
-    if (route) {
+    if (props.as) {
+        return { as: props.as, props: {} };
+    }
+
+    if (props.route) {
         return {
-            tag: 'router-link',
+            as: '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',
+            as: 'a',
             props: {
                 target: '_blank',
-                href: href || url,
+                href: props.href || props.url,
             },
         };
     }
 
     return {
-        tag: 'button',
-        props: { type: submit ? 'submit' : 'button' },
+        as: 'button',
+        props: { type: props.submit ? 'submit' : 'button' },
     };
 });
 </script>

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

@@ -1,8 +1,32 @@
-import type { ComputedRef, DeepReadonly, Ref } from 'vue';
+import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
+
+import { mixedProp, stringProp } from '@/utils';
+import { extractComponentProps } from '@/components/utils';
+import type { FormFieldValue } from '@/forms/Form';
 
 export interface IAGHeadlessInput {
     id: string;
-    value: ComputedRef<string | number | boolean | null>;
+    name: ComputedRef<string | null>;
+    label: ComputedRef<string | null>;
+    description: ComputedRef<string | boolean | null>;
+    value: ComputedRef<FormFieldValue | null>;
     errors: DeepReadonly<Ref<string[] | null>>;
-    update(value: string | number | boolean | null): void;
+    update(value: FormFieldValue | null): void;
+}
+
+export const inputProps = {
+    name: stringProp(),
+    label: stringProp(),
+    description: stringProp(),
+    modelValue: mixedProp<FormFieldValue>([String, Number, Boolean]),
+};
+
+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

@@ -9,16 +9,16 @@
 import { computed, inject, provide, readonly } from 'vue';
 import { uuid } from '@noeldemartin/utils';
 
-import { mixedProp, stringProp } from '@/utils/vue';
+import { 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,8 +28,11 @@ 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),
+    description: computed(() => props.description),
     value: computed(() => {
         if (form && props.name) {
             return form.getFieldValue(props.name);
@@ -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/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>