@aerogel/core 0.0.0-next.824cf5311c4335d119158f507dad094ed4f4f0b6 → 0.0.0-next.8e6b2bcc764fa682decbb41aa6848c77a744dec3

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aerogel/core",
     "description": "The Lightest Solid",
-    "version": "0.0.0-next.824cf5311c4335d119158f507dad094ed4f4f0b6",
+    "version": "0.0.0-next.8e6b2bcc764fa682decbb41aa6848c77a744dec3",
     "main": "dist/aerogel-core.cjs.js",
     "module": "dist/aerogel-core.esm.js",
     "types": "dist/aerogel-core.d.ts",

package/src/bootstrap/index.ts

@@ -6,6 +6,7 @@ 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';
@@ -13,7 +14,7 @@ import type { AerogelOptions } from '@/bootstrap/options';
 export { AerogelOptions };
 
 export async function bootstrapApplication(app: App, options: AerogelOptions = {}): Promise<void> {
-    const plugins = [directives, errors, lang, services, ui, ...(options.plugins ?? [])];
+    const plugins = [testing, directives, errors, lang, services, ui, ...(options.plugins ?? [])];
 
     await installPlugins(plugins, app, options);
     await options.install?.(app);

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/AGHeadlessInputInput.vue

@@ -2,6 +2,7 @@
     <input
         :id="input.id"
         ref="$input"
+        :name="name"
         :type="type"
         :value="value"
         :aria-invalid="input.errors ? 'true' : 'false'"
@@ -26,6 +27,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/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/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/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,10 +1,12 @@
 export * from './bootstrap';
 export * from './components';
+export * from './directives';
 export * from './errors';
 export * from './forms';
 export * from './jobs';
 export * from './lang';
 export * from './plugins';
 export * from './services';
+export * from './testing';
 export * from './ui';
 export * from './utils';

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

@@ -0,0 +1,25 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
+import { definePlugin } from '@/plugins';
+
+export interface AerogelTestingRuntime {
+    on: (typeof Events)['on'];
+}
+
+export default definePlugin({
+    async install() {
+        if (import.meta.env.MODE !== 'testing') {
+            return;
+        }
+
+        globalThis.testingRuntime = {
+            on: ((...args: GetClosureArgs<(typeof Events)['on']>) => Events.on(...args)) as (typeof Events)['on'],
+        };
+    },
+});
+
+declare global {
+    // 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;
     }
 }