@aerogel/core 0.0.0-next.bde642c4a8096c5fc3d5e676c2115da23f4bf1d8 → 0.0.0-next.c2e6acc000e97a1020c2e232678563c53884dd0e

package/src/components/ui/ProgressBar.vue

@@ -0,0 +1,50 @@
+<template>
+    <div class="mt-1 h-2 w-full overflow-hidden rounded-full bg-gray-200">
+        <div :class="filledClasses" :style="`transform:translateX(-${(1 - renderedProgress) * 100}%)`" />
+        <span class="sr-only">
+            {{
+                $td('ui.progress', '{progress}% complete', {
+                    progress: renderedProgress * 100,
+                })
+            }}
+        </span>
+    </div>
+</template>
+
+<script setup lang="ts">
+import { computed, onUnmounted, ref, watch } from 'vue';
+
+import { classes } from '@aerogel/core/components/utils';
+import type Job from '@aerogel/core/jobs/Job';
+
+const { filledClass, progress, job } = defineProps<{
+    filledClass?: string;
+    progress?: number;
+    job?: Job;
+}>();
+
+let cleanup: Function | undefined;
+const jobProgress = ref(0);
+const filledClasses = computed(() =>
+    classes('size-full transition-transform duration-500 rounded-r-full ease-linear bg-primary', filledClass));
+const renderedProgress = computed(() => {
+    if (typeof progress === 'number') {
+        return progress;
+    }
+
+    return jobProgress.value;
+});
+
+watch(
+    () => job,
+    () => {
+        cleanup?.();
+
+        jobProgress.value = job?.progress ?? 0;
+        cleanup = job?.listeners.add({ onUpdated: (value) => (jobProgress.value = value) });
+    },
+    { immediate: true },
+);
+
+onUnmounted(() => cleanup?.());
+</script>

package/src/components/ui/PromptModal.vue

@@ -0,0 +1,35 @@
+<template>
+    <Modal v-slot="{ close }" :title="title" persistent>
+        <Form :form="form" @submit="close(form.draft)">
+            <Markdown :text="message" />
+            <Input
+                name="draft"
+                class="mt-2"
+                :placeholder="placeholder"
+                :label="label"
+            />
+
+            <div class="mt-4 flex flex-row-reverse gap-2">
+                <Button :variant="acceptVariant" submit>
+                    {{ renderedAcceptText }}
+                </Button>
+                <Button :variant="cancelVariant" @click="close(false)">
+                    {{ renderedCancelText }}
+                </Button>
+            </div>
+        </Form>
+    </Modal>
+</template>
+
+<script setup lang="ts">
+import Markdown from '@aerogel/core/components/ui/Markdown.vue';
+import Button from '@aerogel/core/components/ui/Button.vue';
+import Form from '@aerogel/core/components/ui/Form.vue';
+import Input from '@aerogel/core/components/ui/Input.vue';
+import Modal from '@aerogel/core/components/ui/Modal.vue';
+import { usePromptModal } from '@aerogel/core/components/contracts/PromptModal';
+import type { PromptModalProps } from '@aerogel/core/components/contracts/PromptModal';
+
+const { cancelVariant = 'secondary', ...props } = defineProps<PromptModalProps>();
+const { form, renderedAcceptText, renderedCancelText } = usePromptModal(props);
+</script>

package/src/components/ui/index.ts

@@ -0,0 +1,16 @@
+export { default as AlertModal } from './AlertModal.vue';
+export { default as Button } from './Button.vue';
+export { default as Checkbox } from './Checkbox.vue';
+export { default as ConfirmModal } from './ConfirmModal.vue';
+export { default as ErrorReportModal } from './ErrorReportModal.vue';
+export { default as ErrorReportModalButtons } from './ErrorReportModalButtons.vue';
+export { default as ErrorReportModalTitle } from './ErrorReportModalTitle.vue';
+export { default as Form } from './Form.vue';
+export { default as Input } from './Input.vue';
+export { default as Link } from './Link.vue';
+export { default as LoadingModal } from './LoadingModal.vue';
+export { default as Markdown } from './Markdown.vue';
+export { default as Modal } from './Modal.vue';
+export { default as ModalContext } from './ModalContext.vue';
+export { default as ProgressBar } from './ProgressBar.vue';
+export { default as PromptModal } from './PromptModal.vue';

package/src/components/utils.ts

@@ -1,10 +1,107 @@
-export function extractComponentProps<T extends Record<string, unknown>>(
-    values: Record<string, unknown>,
-    definitions: Record<string, unknown>,
-): T {
-    return Object.keys(definitions).reduce((extracted, prop) => {
-        extracted[prop] = values[prop];
-
-        return extracted;
-    }, {} as Record<string, unknown>) as T;
+import clsx from 'clsx';
+import { computed, customRef, inject, onUnmounted, unref } from 'vue';
+import { cva } from 'class-variance-authority';
+import { isObject } from '@noeldemartin/utils';
+import { twMerge } from 'tailwind-merge';
+import type { ClassValue } from 'clsx';
+import type { ComputedRef, ExtractPropTypes, PropType, Ref, UnwrapNestedRefs } from 'vue';
+import type { GetClosureArgs, GetClosureResult, Nullable } from '@noeldemartin/utils';
+
+import type { HasElement } from '@aerogel/core/components/contracts/shared';
+import type { FormController } from '@aerogel/core/forms';
+
+export type CVAConfig<T> = NonNullable<GetClosureArgs<typeof cva<T>>[1]>;
+export type CVAProps<T> = NonNullable<GetClosureArgs<GetClosureResult<typeof cva<T>>>[0]>;
+export type RefsObject<T> = { [K in keyof T]: Ref<T[K]> | T[K] };
+export type Variants<T extends Record<string, string>> = Required<{
+    [K in keyof T]: {
+        [key in T[K]]: string;
+    };
+}>;
+
+export type ComponentPropDefinitions<T> = {
+    [K in keyof T]: {
+        type?: PropType<T[K]>;
+        default: T[K] | (() => T[K]) | null;
+    };
+};
+
+export type PickComponentProps<TValues, TDefinitions> = {
+    [K in keyof TValues]: K extends keyof TDefinitions ? TValues[K] : never;
+};
+
+export function computedVariantClasses<T>(
+    value: RefsObject<{ baseClasses?: string } & CVAProps<T>>,
+    config: { baseClasses?: string } & CVAConfig<T>,
+): ComputedRef<string> {
+    return computed(() => {
+        const { baseClasses: valueBaseClasses, ...valueRefs } = value;
+        const { baseClasses: configBaseClasses, ...configs } = config;
+        const variants = cva(configBaseClasses, configs as CVAConfig<T>);
+        const values = Object.entries(valueRefs).reduce((extractedValues, [name, valueRef]) => {
+            extractedValues[name as keyof CVAProps<T>] = unref(valueRef);
+
+            return extractedValues;
+        }, {} as CVAProps<T>);
+
+        return classes(variants(values), unref(valueBaseClasses));
+    });
+}
+
+export function classes(...inputs: ClassValue[]): string {
+    return twMerge(clsx(inputs));
+}
+
+export function elementRef(): Ref<HTMLElement | undefined> {
+    return customRef((track, trigger) => {
+        let value: HTMLElement | undefined = undefined;
+
+        return {
+            get() {
+                track();
+
+                return value;
+            },
+            set(newValue) {
+                value = getElement(newValue);
+
+                trigger();
+            },
+        };
+    });
+}
+
+export function extractComponentProps<TDefinitions extends {}, TValues extends ExtractPropTypes<TDefinitions>>(
+    values: TValues,
+    definitions: TDefinitions,
+): PickComponentProps<TValues, TDefinitions> {
+    return Object.keys(definitions).reduce(
+        (extracted, prop) => {
+            extracted[prop] = values[prop as keyof TValues];
+
+            return extracted;
+        },
+        {} as Record<string, unknown>,
+    ) as PickComponentProps<TValues, TDefinitions>;
+}
+
+export function getElement(value: unknown): HTMLElement | undefined {
+    if (value instanceof HTMLElement) {
+        return value;
+    }
+
+    if (hasElement(value)) {
+        return value.$el;
+    }
+}
+
+export function hasElement(value: unknown): value is UnwrapNestedRefs<HasElement> {
+    return isObject(value) && '$el' in value;
+}
+
+export function onFormFocus(input: { name: Nullable<string> }, listener: () => unknown): void {
+    const form = inject<FormController | null>('form', null);
+    const stop = form?.on('focus', (name) => input.name === name && listener());
+
+    onUnmounted(() => stop?.());
 }

package/src/directives/index.ts

@@ -1,13 +1,11 @@
 import type { Directive } from 'vue';
 
-import { definePlugin } from '@/plugins';
+import { definePlugin } from '@aerogel/core/plugins';
 
-import initialFocus from './initial-focus';
 import measure from './measure';
 
 const builtInDirectives: Record<string, Directive> = {
-    'initial-focus': initialFocus,
-    'measure': measure,
+    measure: measure,
 };
 
 export * from './measure';
@@ -25,8 +23,14 @@ export default definePlugin({
     },
 });
 
-declare module '@/bootstrap/options' {
+declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
         directives?: Record<string, Directive>;
     }
 }
+
+declare module 'vue' {
+    interface ComponentCustomDirectives {
+        measure: Directive<string, string>;
+    }
+}

package/src/directives/measure.ts

@@ -1,4 +1,7 @@
-import { defineDirective } from '@/utils/vue';
+import { defineDirective } from '@aerogel/core/utils/vue';
+import { tap } from '@noeldemartin/utils';
+
+const resizeObservers: WeakMap<HTMLElement, ResizeObserver> = new WeakMap();
 
 export interface ElementSize {
     width: number;
@@ -9,13 +12,29 @@ export type MeasureDirectiveListener = (size: ElementSize) => unknown;
 
 export default defineDirective({
     mounted(element: HTMLElement, { value }) {
+        // TODO replace with argument when typed properly
+        const modifiers = { css: true, watch: true };
+
         const listener = typeof value === 'function' ? (value as MeasureDirectiveListener) : null;
-        const sizes = element.getBoundingClientRect();
+        const update = () => {
+            const sizes = element.getBoundingClientRect();
+
+            if (modifiers.css) {
+                element.style.setProperty('--width', `${sizes.width}px`);
+                element.style.setProperty('--height', `${sizes.height}px`);
+            }
 
-        // TODO guard with modifiers.css once typed properly
-        element.style.setProperty('--width', `${sizes.width}px`);
-        element.style.setProperty('--height', `${sizes.height}px`);
+            listener?.({ width: sizes.width, height: sizes.height });
+        };
 
-        listener?.({ width: sizes.width, height: sizes.height });
+        if (modifiers.watch) {
+            resizeObservers.set(element, tap(new ResizeObserver(update)).observe(element));
+        }
+
+        update();
+    },
+    unmounted(element) {
+        resizeObservers.get(element)?.unobserve(element);
+        resizeObservers.delete(element);
     },
 });

package/src/errors/Errors.state.ts

@@ -1,6 +1,6 @@
 import type { JSError } from '@noeldemartin/utils';
 
-import { defineServiceState } from '@/services';
+import { defineServiceState } from '@aerogel/core/services';
 
 export type ErrorSource = string | Error | JSError | unknown;
 

package/src/errors/Errors.ts

@@ -1,16 +1,16 @@
-import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty, toString } from '@noeldemartin/utils';
 
-import App from '@/services/App';
-import ServiceBootError from '@/errors/ServiceBootError';
-import UI, { UIComponents } from '@/ui/UI';
-import { translateWithDefault } from '@/lang/utils';
+import App from '@aerogel/core/services/App';
+import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
+import UI, { UIComponents } from '@aerogel/core/ui/UI';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
+import { Colors } from '@aerogel/core/components/constants';
+import { Events } from '@aerogel/core/services';
+import type { ErrorReportModalProps } from '@aerogel/core/components/contracts/ErrorReportModal';
+import type { ModalComponent } from '@aerogel/core/ui/UI.state';
 
 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';
 
 export class ErrorsService extends Service {
 
@@ -34,7 +34,7 @@ export class ErrorsService extends Service {
             return;
         }
 
-        UI.openModal<ModalComponent<AGErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
+        UI.openModal<ModalComponent<ErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
             reports,
         });
     }
@@ -42,11 +42,11 @@ export class ErrorsService extends Service {
     public async report(error: ErrorSource, message?: string): Promise<void> {
         await Events.emit('error', { error, message });
 
-        if (App.testing) {
+        if (isTesting('unit')) {
             throw error;
         }
 
-        if (App.development) {
+        if (isDevelopment()) {
             this.logError(error);
         }
 
@@ -81,7 +81,7 @@ export class ErrorsService extends Service {
                         text: translateWithDefault('errors.viewDetails', 'View details'),
                         dismiss: true,
                         handler: () =>
-                            UI.openModal<ModalComponent<AGErrorReportModalProps>>(
+                            UI.openModal<ModalComponent<ErrorReportModalProps>>(
                                 UI.requireComponent(UIComponents.ErrorReportModal),
                                 { reports: [report] },
                             ),
@@ -178,7 +178,7 @@ export class ErrorsService extends Service {
 
 export default facade(ErrorsService);
 
-declare module '@/services/Events' {
+declare module '@aerogel/core/services/Events' {
     export interface EventsPayload {
         error: { error: ErrorSource; message?: string };
     }

package/src/errors/JobCancelledError.ts

@@ -0,0 +1,3 @@
+import { JSError } from '@noeldemartin/utils';
+
+export default class JobCancelledError extends JSError {}

package/src/errors/index.ts

@@ -1,13 +1,16 @@
 import type { App } from 'vue';
 
-import { bootServices } from '@/services';
-import { definePlugin } from '@/plugins';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
 
 import Errors from './Errors';
-import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
 
 export * from './utils';
-export { Errors, ErrorSource, ErrorReport, ErrorReportLog };
+export { Errors };
+export { default as JobCancelledError } from './JobCancelledError';
+export { default as ServiceBootError } from './ServiceBootError';
+export type { ErrorSource, ErrorReport, ErrorReportLog };
 
 const services = { $errors: Errors };
 const frameworkHandler: ErrorHandler = (error) => {
@@ -35,12 +38,12 @@ export default definePlugin({
     },
 });
 
-declare module '@/bootstrap/options' {
+declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
         handleError?(error: ErrorSource): boolean;
     }
 }
 
-declare module '@/services' {
+declare module '@aerogel/core/services' {
     export interface Services extends ErrorsServices {}
 }

package/src/errors/utils.ts

@@ -1,8 +1,24 @@
 import { JSError, isObject, toString } from '@noeldemartin/utils';
-import { translateWithDefault } from '@/lang/utils';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
 import type { ErrorSource } from './Errors.state';
 
+const handlers: ErrorHandler[] = [];
+
+export type ErrorHandler = (error: ErrorSource) => string | undefined;
+
+export function registerErrorHandler(handler: ErrorHandler): void {
+    handlers.push(handler);
+}
+
 export function getErrorMessage(error: ErrorSource): string {
+    for (const handler of handlers) {
+        const result = handler(error);
+
+        if (result) {
+            return result;
+        }
+    }
+
     if (typeof error === 'string') {
         return error;
     }

package/src/forms/{Form.test.ts → FormController.test.ts}

@@ -1,10 +1,11 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
 
-import { useForm } from './composition';
-import { FormFieldTypes } from '@/main';
-import { numberInput, requiredStringInput } from '@/forms/utils';
+import { useForm } from '@aerogel/core/forms/composition';
+import { numberInput, requiredStringInput } from '@aerogel/core/forms/utils';
 
-describe('Form', () => {
+import { FormFieldTypes } from './FormController';
+
+describe('FormController', () => {
 
     it('defines magic fields', () => {
         const form = useForm({
@@ -55,4 +56,32 @@ describe('Form', () => {
         expect(form.name).toBeNull();
     });
 
+    it('trims values', () => {
+        // Arrange
+        const form = useForm({
+            trimmed: {
+                type: FormFieldTypes.String,
+                rules: 'required',
+            },
+            untrimmed: {
+                type: FormFieldTypes.String,
+                rules: 'required',
+                trim: false,
+            },
+        });
+
+        // Act
+        form.trimmed = '   ';
+        form.untrimmed = '   ';
+
+        form.submit();
+
+        // Assert
+        expect(form.valid).toBe(false);
+        expect(form.submitted).toBe(true);
+        expect(form.trimmed).toEqual('');
+        expect(form.untrimmed).toEqual('   ');
+        expect(form.errors).toEqual({ trimmed: ['required'], untrimmed: null });
+    });
+
 });

package/src/forms/{Form.ts → FormController.ts}

@@ -1,5 +1,6 @@
-import { MagicObject, arrayRemove } from '@noeldemartin/utils';
 import { computed, nextTick, reactive, readonly, ref } from 'vue';
+import { MagicObject, arrayRemove, fail, toString } from '@noeldemartin/utils';
+import { validate } from './validation';
 import type { ObjectValues } from '@noeldemartin/utils';
 import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
 
@@ -13,6 +14,7 @@ export const FormFieldTypes = {
 
 export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
     type: TType;
+    trim?: boolean;
     default?: GetFormFieldValue<TType>;
     rules?: TRules;
 }
@@ -36,21 +38,21 @@ export type FormErrors<T> = {
 export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.String
     ? string
     : TType extends typeof FormFieldTypes.Number
-    ? number
-    : TType extends typeof FormFieldTypes.Boolean
-    ? boolean
-    : TType extends typeof FormFieldTypes.Object
-    ? object
-    : TType extends typeof FormFieldTypes.Date
-    ? Date
-    : never;
+      ? number
+      : TType extends typeof FormFieldTypes.Boolean
+        ? boolean
+        : TType extends typeof FormFieldTypes.Object
+          ? object
+          : TType extends typeof FormFieldTypes.Date
+            ? Date
+            : never;
 
-const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
+const validForms: WeakMap<FormController, ComputedRef<boolean>> = new WeakMap();
 
 export type SubmitFormListener = () => unknown;
 export type FocusFormListener = (input: string) => unknown;
 
-export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
+export default class FormController<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
 
     public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
 
@@ -85,7 +87,13 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     }
 
     public setFieldValue<T extends keyof Fields>(field: T, value: FormData<Fields>[T]): void {
-        this._data[field] = value;
+        const definition =
+            this._fields[field] ?? fail<FormFieldDefinition>(`Trying to set undefined '${toString(field)}' field`);
+
+        this._data[field] =
+            definition.type === FormFieldTypes.String && (definition.trim ?? true)
+                ? (toString(value).trim() as FormData<Fields>[T])
+                : value;
 
         if (this._submitted.value) {
             this.validate();
@@ -96,16 +104,23 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         return this._data[field] as unknown as GetFormFieldValue<Fields[T]['type']>;
     }
 
+    public getFieldRules<T extends keyof Fields>(field: T): string[] {
+        return this._fields[field]?.rules?.split('|') ?? [];
+    }
+
     public data(): FormData<Fields> {
         return { ...this._data };
     }
 
     public validate(): boolean {
-        const errors = Object.entries(this._fields).reduce((formErrors, [name, definition]) => {
-            formErrors[name] = this.getFieldErrors(name, definition);
+        const errors = Object.entries(this._fields).reduce(
+            (formErrors, [name, definition]) => {
+                formErrors[name] = this.getFieldErrors(name, definition);
 
-            return formErrors;
-        }, {} as Record<string, string[] | null>);
+                return formErrors;
+            },
+            {} as Record<string, string[] | null>,
+        );
 
         this.resetErrors(errors);
 
@@ -153,29 +168,35 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         this._listeners['focus']?.forEach((listener) => listener(input));
     }
 
-    protected __get(property: string): unknown {
+    protected override __get(property: string): unknown {
         if (!(property in this._fields)) {
             return super.__get(property);
         }
 
-        return this._data[property];
+        return this.getFieldValue(property);
     }
 
-    protected __set(property: string, value: unknown): void {
+    protected override __set(property: string, value: unknown): void {
         if (!(property in this._fields)) {
             super.__set(property, value);
 
             return;
         }
 
-        Object.assign(this._data, { [property]: value });
+        this.setFieldValue(property, value as FormData<Fields>[string]);
     }
 
     private getFieldErrors(name: keyof Fields, definition: FormFieldDefinition): string[] | null {
         const errors = [];
+        const value = this._data[name];
+        const rules = definition.rules?.split('|') ?? [];
+
+        for (const rule of rules) {
+            if (rule !== 'required' && (value === null || value === undefined)) {
+                continue;
+            }
 
-        if (definition.rules?.includes('required') && !this._data[name]) {
-            errors.push('required');
+            errors.push(...validate(value, rule));
         }
 
         return errors.length > 0 ? errors : null;
@@ -186,10 +207,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             return {} as FormData<Fields>;
         }
 
-        const data = Object.entries(fields).reduce((formData, [name, definition]) => {
-            formData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
+        const data = Object.entries(fields).reduce((initialData, [name, definition]) => {
+            initialData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
 
-            return formData;
+            return initialData;
         }, {} as FormData<Fields>);
 
         return reactive(data) as FormData<Fields>;

package/src/forms/composition.ts

@@ -1,6 +1,6 @@
-import Form from '@/forms/Form';
-import type { FormData, FormFieldDefinitions } from '@/forms/Form';
+import FormController from '@aerogel/core/forms/FormController';
+import type { FormData, FormFieldDefinitions } from '@aerogel/core/forms/FormController';
 
-export function useForm<const T extends FormFieldDefinitions>(fields: T): Form<T> & FormData<T> {
-    return new Form(fields) as Form<T> & FormData<T>;
+export function useForm<const T extends FormFieldDefinitions>(fields: T): FormController<T> & FormData<T> {
+    return new FormController(fields) as FormController<T> & FormData<T>;
 }

package/src/forms/index.ts

@@ -1,4 +1,5 @@
-export * from './Form';
 export * from './composition';
+export * from './FormController';
 export * from './utils';
-export { default as Form } from './Form';
+export * from './validation';
+export { default as FormController } from './FormController';