@aerogel/core 0.0.0-next.669133ce9c5f0eeaff1b63c4e2962e90129cfc1a → 0.0.0-next.71f28064caa2ea968f0e99396b672de218176260

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aerogel/core",
     "description": "The Lightest Solid",
-    "version": "0.0.0-next.669133ce9c5f0eeaff1b63c4e2962e90129cfc1a",
+    "version": "0.0.0-next.71f28064caa2ea968f0e99396b672de218176260",
     "main": "dist/aerogel-core.cjs.js",
     "module": "dist/aerogel-core.esm.js",
     "types": "dist/aerogel-core.d.ts",

package/src/components/forms/AGInput.vue

@@ -13,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>
@@ -26,6 +27,7 @@ import { useInputProps } from '@/components/headless/forms/AGHeadlessInput';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
 import AGHeadlessInput from '../headless/forms/AGHeadlessInput.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';

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

@@ -1,12 +1,13 @@
 import type { ComputedRef, DeepReadonly, ExtractPropTypes, Ref } from 'vue';
 
-import { stringProp } from '@/utils';
+import { mixedProp, 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;
@@ -15,6 +16,8 @@ export interface IAGHeadlessInput {
 export const inputProps = {
     name: stringProp(),
     label: stringProp(),
+    description: stringProp(),
+    modelValue: mixedProp<string | number | boolean>([String, Number, Boolean]),
 };
 
 export function useInputProps(): typeof inputProps {

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

@@ -9,7 +9,7 @@
 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';
@@ -18,7 +18,6 @@ import type { IAGHeadlessInput } from './AGHeadlessInput';
 const emit = defineEmits(['update:modelValue']);
 const props = defineProps({
     as: stringProp('div'),
-    modelValue: mixedProp<string | number | boolean>([String, Number, Boolean]),
     ...useInputProps(),
 });
 const errors = computed(() => {
@@ -33,6 +32,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"
     >
@@ -17,6 +20,8 @@ import { computed, ref } from 'vue';
 import { injectReactiveOrFail, stringProp } from '@/utils';
 import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
 
+import { onFormFocus } from './composition';
+
 const props = defineProps({
     type: stringProp('text'),
 });
@@ -26,6 +31,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') {
@@ -42,4 +48,6 @@ function update() {
 
     input.update(props.type === 'checkbox' ? $input.value.checked : $input.value.value);
 }
+
+onFormFocus(input, () => $input.value?.focus());
 </script>

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

@@ -0,0 +1,40 @@
+<template>
+    <textarea
+        :id="input.id"
+        ref="$textArea"
+        :name="name"
+        :value="value"
+        :aria-invalid="input.errors ? 'true' : 'false'"
+        :aria-describedby="
+            input.errors ? `${input.id}-error` : input.description ? `${input.id}-description` : undefined
+        "
+        @input="update"
+    />
+</template>
+
+<script setup lang="ts">
+import { computed, ref } from 'vue';
+
+import { injectReactiveOrFail } from '@/utils';
+import type { IAGHeadlessInput } from '@/components/headless/forms/AGHeadlessInput';
+
+import { onFormFocus } from './composition';
+
+const $textArea = ref<HTMLTextAreaElement>();
+const input = injectReactiveOrFail<IAGHeadlessInput>(
+    'input',
+    '<AGHeadlessInputTextArea> must be a child of a <AGHeadlessInput>',
+);
+const name = computed(() => input.name ?? undefined);
+const value = computed(() => input.value as string);
+
+function update() {
+    if (!$textArea.value) {
+        return;
+    }
+
+    input.update($textArea.value.value);
+}
+
+onFormFocus(input, () => $textArea.value?.focus());
+</script>

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

@@ -0,0 +1,10 @@
+import { inject, onUnmounted } from 'vue';
+
+import type Form from '@/forms/Form';
+
+export function onFormFocus(input: { name: string | null }, listener: () => unknown): void {
+    const form = inject<Form | null>('form', null);
+    const stop = form?.on('focus', (name) => input.name === name && listener());
+
+    onUnmounted(() => stop?.());
+}

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

@@ -1,8 +1,10 @@
+export * from './composition';
 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 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';

package/src/components/lib/AGErrorMessage.vue

@@ -5,12 +5,12 @@
 <script setup lang="ts">
 import { computed } from 'vue';
 
-import Errors from '@/errors/Errors';
 import { requiredObjectProp } from '@/utils/vue';
+import { getErrorMessage } from '@/errors/utils';
 import type { ErrorSource } from '@/errors/Errors.state';
 
 import AGMarkdown from './AGMarkdown.vue';
 
 const props = defineProps({ error: requiredObjectProp<ErrorSource>() });
-const message = computed(() => Errors.getErrorMessage(props.error));
+const message = computed(() => getErrorMessage(props.error));
 </script>

package/src/components/lib/AGMarkdown.vue

@@ -3,7 +3,7 @@
 </template>
 
 <script setup lang="ts">
-import { computed, h } from 'vue';
+import { computed, h, useAttrs } from 'vue';
 
 import { renderMarkdown } from '@/utils/markdown';
 import { booleanProp, objectProp, stringProp } from '@/utils/vue';
@@ -17,6 +17,7 @@ const props = defineProps({
     text: stringProp(),
 });
 
+const attrs = useAttrs();
 const markdown = computed(() => props.text ?? (props.langKey && translate(props.langKey, props.langParams ?? {})));
 const html = computed(() => {
     if (!markdown.value) {
@@ -32,5 +33,9 @@ const html = computed(() => {
     return renderedHtml;
 });
 const root = () =>
-    h(props.as ?? (props.inline ? 'span' : 'div'), { class: props.inline ? '' : 'prose', innerHTML: html.value });
+    h(props.as ?? (props.inline ? 'span' : 'div'), {
+        class: props.inline ? '' : 'prose',
+        innerHTML: html.value,
+        ...attrs,
+    });
 </script>

package/src/directives/index.ts

@@ -10,6 +10,8 @@ const builtInDirectives: Record<string, Directive> = {
     'measure': measure,
 };
 
+export * from './measure';
+
 export default definePlugin({
     install(app, options) {
         const directives = {

package/src/directives/measure.ts

@@ -1,12 +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 }: { value?: () => unknown }) {
+    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`);
 
-        value?.();
+        listener?.({ width: sizes.width, height: sizes.height });
     },
 });

package/src/errors/Errors.ts

@@ -7,6 +7,7 @@ import { translateWithDefault } from '@/lang/utils';
 
 import Service from './Errors.state';
 import { Colors } from '@/components/constants';
+import { Events } from '@/services';
 import type { AGErrorReportModalProps } from '@/components/modals/AGErrorReportModal';
 import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
 import type { ModalComponent } from '@/ui/UI.state';
@@ -39,6 +40,8 @@ export class ErrorsService extends Service {
     }
 
     public async report(error: ErrorSource, message?: string): Promise<void> {
+        await Events.emit('error', { error, message });
+
         if (App.testing) {
             throw error;
         }
@@ -114,22 +117,6 @@ export class ErrorsService extends Service {
         });
     }
 
-    public getErrorMessage(error: ErrorSource): string {
-        if (typeof error === 'string') {
-            return error;
-        }
-
-        if (error instanceof Error || error instanceof JSError) {
-            return error.message;
-        }
-
-        if (isObject(error)) {
-            return toString(error['message'] ?? error['description'] ?? 'Unknown error object');
-        }
-
-        return translateWithDefault('errors.unknown', 'Unknown Error');
-    }
-
     private logError(error: unknown): void {
         // eslint-disable-next-line no-console
         console.error(error);
@@ -190,3 +177,9 @@ export class ErrorsService extends Service {
 }
 
 export default facade(ErrorsService);
+
+declare module '@/services/Events' {
+    export interface EventsPayload {
+        error: { error: ErrorSource; message?: string };
+    }
+}

package/src/errors/index.ts

@@ -6,6 +6,7 @@ import { definePlugin } from '@/plugins';
 import Errors from './Errors';
 import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
 
+export * from './utils';
 export { Errors, ErrorSource, ErrorReport, ErrorReportLog };
 
 const services = { $errors: Errors };

package/src/errors/utils.ts

@@ -0,0 +1,19 @@
+import { JSError, isObject, toString } from '@noeldemartin/utils';
+import { translateWithDefault } from '@/lang/utils';
+import type { ErrorSource } from './Errors.state';
+
+export function getErrorMessage(error: ErrorSource): string {
+    if (typeof error === 'string') {
+        return error;
+    }
+
+    if (error instanceof Error || error instanceof JSError) {
+        return error.message;
+    }
+
+    if (isObject(error)) {
+        return toString(error['message'] ?? error['description'] ?? 'Unknown error object');
+    }
+
+    return translateWithDefault('errors.unknown', 'Unknown Error');
+}

package/src/forms/Form.ts

@@ -1,5 +1,5 @@
-import { MagicObject } from '@noeldemartin/utils';
-import { computed, reactive, readonly, ref } from 'vue';
+import { MagicObject, arrayRemove } from '@noeldemartin/utils';
+import { computed, nextTick, reactive, readonly, ref } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
 import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
 
@@ -44,6 +44,8 @@ export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.Strin
 
 const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
 
+export type FormListener = (input: string) => unknown;
+
 export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
 
     public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
@@ -52,6 +54,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     private _data: FormData<Fields>;
     private _submitted: Ref<boolean>;
     private _errors: FormErrors<Fields>;
+    private _listeners: Record<string, FormListener[]> = {};
 
     constructor(fields: Fields) {
         super();
@@ -114,6 +117,23 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         return this.validate();
     }
 
+    public on(event: string, listener: FormListener): () => void {
+        this._listeners[event] ??= [];
+        this._listeners[event]?.push(listener);
+
+        return () => this.off(event, listener);
+    }
+
+    public off(event: string, listener: FormListener): void {
+        arrayRemove(this._listeners[event] ?? [], listener);
+    }
+
+    public async focus(input: string): Promise<void> {
+        await nextTick();
+
+        this._listeners['focus']?.forEach((listener) => listener(input));
+    }
+
     protected __get(property: string): unknown {
         if (!(property in this._fields)) {
             return super.__get(property);

package/src/lang/Lang.ts

@@ -1,10 +1,11 @@
-import { facade, toString } from '@noeldemartin/utils';
+import { facade } from '@noeldemartin/utils';
 
 import App from '@/services/App';
 import Service from '@/services/Service';
 
 export interface LangProvider {
     translate(key: string, parameters?: Record<string, unknown>): string;
+    translateWithDefault(key: string, defaultMessage: string, parameters?: Record<string, unknown>): string;
 }
 
 export class LangService extends Service {
@@ -21,6 +22,12 @@ export class LangService extends Service {
 
                 return key;
             },
+            translateWithDefault: (_, defaultMessage) => {
+                // eslint-disable-next-line no-console
+                App.development && console.warn('Lang provider is missing');
+
+                return defaultMessage;
+            },
         };
     }
 
@@ -32,27 +39,8 @@ export class LangService extends Service {
         return this.provider.translate(key, parameters) ?? key;
     }
 
-    public translateWithDefault(key: string, defaultMessage: string): string;
-    public translateWithDefault(key: string, parameters: Record<string, unknown>, defaultMessage: string): string;
-    public translateWithDefault(
-        key: string,
-        defaultMessageOrParameters?: string | Record<string, unknown>,
-        defaultMessage?: string,
-    ): string {
-        defaultMessage ??= defaultMessageOrParameters as string;
-
-        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters ?? {};
-        const message = this.provider.translate(key, parameters) ?? key;
-
-        if (message === key) {
-            return Object.entries(parameters).reduce(
-                (renderedMessage, [name, value]) =>
-                    renderedMessage.replace(new RegExp(`\\{\\s*${name}\\s*\\}`, 'g'), toString(value)),
-                defaultMessage,
-            );
-        }
-
-        return message;
+    public translateWithDefault(key: string, defaultMessage: string, parameters: Record<string, unknown> = {}): string {
+        return this.provider.translateWithDefault(key, defaultMessage, parameters);
     }
 
 }

package/src/main.ts

@@ -1,5 +1,6 @@
 export * from './bootstrap';
 export * from './components';
+export * from './directives';
 export * from './errors';
 export * from './forms';
 export * from './jobs';

package/src/services/Events.ts

@@ -6,6 +6,8 @@ export interface EventsPayload {}
 export interface EventListenerOptions {
     priority: number;
 }
+export type AerogelGlobalEvents = Partial<{ [Event in EventWithoutPayload]: () => unknown }> &
+    Partial<{ [Event in EventWithPayload]: EventListener<EventsPayload[Event]> }>;
 
 export type EventListener<T = unknown> = (payload: T) => unknown;
 export type UnknownEvent<T> = T extends keyof EventsPayload ? never : T;
@@ -28,6 +30,11 @@ export class EventsService extends Service {
 
     private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
 
+    protected async boot(): Promise<void> {
+        Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
+            this.on(event as string, listener as EventListener));
+    }
+
     public emit<Event extends EventWithoutPayload>(event: Event): Promise<void>;
     public emit<Event extends EventWithPayload>(event: Event, payload: EventsPayload[Event]): Promise<void>;
     public emit<Event extends string>(event: UnknownEvent<Event>, payload?: unknown): Promise<void>;
@@ -141,3 +148,8 @@ export class EventsService extends Service {
 }
 
 export default facade(EventsService);
+
+declare global {
+    // eslint-disable-next-line no-var
+    var __aerogelEvents__: AerogelGlobalEvents | undefined;
+}

package/src/testing/index.ts

@@ -1,6 +1,11 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
 import { definePlugin } from '@/plugins';
 
-export interface AerogelTestingRuntime {}
+export interface AerogelTestingRuntime {
+    on: (typeof Events)['on'];
+}
 
 export default definePlugin({
     async install() {
@@ -8,12 +13,13 @@ export default definePlugin({
             return;
         }
 
-        window.testingRuntime = {};
+        globalThis.testingRuntime = {
+            on: ((...args: GetClosureArgs<(typeof Events)['on']>) => Events.on(...args)) as (typeof Events)['on'],
+        };
     },
 });
 
 declare global {
-    interface Window {
-        testingRuntime?: AerogelTestingRuntime;
-    }
+    // eslint-disable-next-line no-var
+    var testingRuntime: AerogelTestingRuntime | undefined;
 }

package/src/ui/UI.ts

@@ -167,7 +167,7 @@ export class UIService extends Service {
         const snackbar: Snackbar = {
             id: uuid(),
             properties: { message, ...options },
-            component: options.component ?? markRaw(this.requireComponent(UIComponents.Snackbar)),
+            component: markRaw(options.component ?? this.requireComponent(UIComponents.Snackbar)),
         };
 
         this.setState('snackbars', this.snackbars.concat(snackbar));
@@ -274,10 +274,12 @@ export default facade(UIService);
 
 declare module '@/services/Events' {
     export interface EventsPayload {
-        'modal-will-close': { modal: Modal; result?: unknown };
-        'modal-closed': { modal: Modal; result?: unknown };
         'close-modal': { id: string; result?: unknown };
         'hide-modal': { id: string };
+        'hide-overlays-backdrop': void;
+        'modal-closed': { modal: Modal; result?: unknown };
+        'modal-will-close': { modal: Modal; result?: unknown };
         'show-modal': { id: string };
+        'show-overlays-backdrop': void;
     }
 }