@aerogel/core 0.0.0-next.7035064d9ec6a82a936ee8dfcc4b58ed2e25a399 → 0.0.0-next.73a6df428477c011a1aebe0a932ebef0aa5e1b16

package/src/errors/Errors.ts

@@ -1,21 +1,21 @@
-import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+import { watchEffect } from 'vue';
+import type Eruda from 'eruda';
 
-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 from '@aerogel/core/ui/UI';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
+import { Events } from '@aerogel/core/services';
 
 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 {
 
     public forceReporting: boolean = false;
     private enabled: boolean = true;
+    private eruda: typeof Eruda | null = null;
 
     public enable(): void {
         this.enabled = true;
@@ -25,28 +25,33 @@ export class ErrorsService extends Service {
         this.enabled = false;
     }
 
-    public async inspect(error: ErrorSource | ErrorReport[]): Promise<void> {
-        const reports = Array.isArray(error) ? (error as ErrorReport[]) : [await this.createErrorReport(error)];
-
-        if (reports.length === 0) {
+    public async inspect(error: ErrorSource | ErrorReport, reports?: ErrorReport[]): Promise<void>;
+    public async inspect(reports: ErrorReport[]): Promise<void>;
+    public async inspect(errorOrReports: ErrorSource | ErrorReport[], _reports?: ErrorReport[]): Promise<void> {
+        if (Array.isArray(errorOrReports) && errorOrReports.length === 0) {
             UI.alert(translateWithDefault('errors.inspectEmpty', 'Nothing to inspect!'));
 
             return;
         }
 
-        UI.openModal<ModalComponent<AGErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
-            reports,
-        });
+        const report = Array.isArray(errorOrReports)
+            ? (errorOrReports[0] as ErrorReport)
+            : this.isErrorReport(errorOrReports)
+                ? errorOrReports
+                : await this.createErrorReport(errorOrReports);
+        const reports = Array.isArray(errorOrReports) ? (errorOrReports as ErrorReport[]) : (_reports ?? [report]);
+
+        UI.modal(UI.requireComponent('error-report-modal'), { report, reports });
     }
 
     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);
         }
 
@@ -71,20 +76,16 @@ export class ErrorsService extends Service {
             date: new Date(),
         };
 
-        UI.showSnackbar(
+        UI.toast(
             message ??
                 translateWithDefault('errors.notice', 'Something went wrong, but it\'s not your fault. Try again!'),
             {
-                color: Colors.Danger,
+                variant: 'danger',
                 actions: [
                     {
-                        text: translateWithDefault('errors.viewDetails', 'View details'),
+                        label: translateWithDefault('errors.viewDetails', 'View details'),
                         dismiss: true,
-                        handler: () =>
-                            UI.openModal<ModalComponent<AGErrorReportModalProps>>(
-                                UI.requireComponent(UIComponents.ErrorReportModal),
-                                { reports: [report] },
-                            ),
+                        click: () => UI.modal(UI.requireComponent('error-report-modal'), { report, reports: [report] }),
                     },
                 ],
             },
@@ -93,6 +94,19 @@ export class ErrorsService extends Service {
         this.setState({ logs: [log].concat(this.logs) });
     }
 
+    public reportDevelopmentError(error: ErrorSource, message?: string): void {
+        if (!isDevelopment()) {
+            return;
+        }
+
+        if (message) {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+        }
+
+        this.logError(error);
+    }
+
     public see(report: ErrorReport): void {
         this.setState({
             logs: this.logs.map((log) => {
@@ -108,12 +122,17 @@ export class ErrorsService extends Service {
         });
     }
 
-    public seeAll(): void {
-        this.setState({
-            logs: this.logs.map((log) => ({
-                ...log,
-                seen: true,
-            })),
+    protected override async boot(): Promise<void> {
+        watchEffect(async () => {
+            if (!this.debug) {
+                this.eruda?.destroy();
+
+                return;
+            }
+
+            this.eruda ??= (await import('eruda')).default;
+
+            this.eruda.init();
         });
     }
 
@@ -126,6 +145,10 @@ export class ErrorsService extends Service {
         }
     }
 
+    private isErrorReport(error: unknown): error is ErrorReport {
+        return isObject(error) && 'title' in error;
+    }
+
     private async createErrorReport(error: ErrorSource): Promise<ErrorReport> {
         if (typeof error === 'string') {
             return { title: error };
@@ -178,7 +201,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/index.ts

@@ -1,13 +1,18 @@
-import type { App } from 'vue';
+import type { App as AppInstance } from 'vue';
 
-import { bootServices } from '@/services';
-import { definePlugin } from '@/plugins';
+import App from '@aerogel/core/services/App';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
 
 import Errors from './Errors';
-import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+import settings from './settings';
+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) => {
@@ -16,7 +21,7 @@ const frameworkHandler: ErrorHandler = (error) => {
     return true;
 };
 
-function setUpErrorHandler(app: App, baseHandler: ErrorHandler = () => false): void {
+function setUpErrorHandler(app: AppInstance, baseHandler: ErrorHandler = () => false): void {
     const errorHandler: ErrorHandler = (error) => baseHandler(error) || frameworkHandler(error);
 
     app.config.errorHandler = errorHandler;
@@ -31,16 +36,18 @@ export default definePlugin({
     async install(app, options) {
         setUpErrorHandler(app, options.handleError);
 
+        settings.forEach((setting) => App.addSetting(setting));
+
         await bootServices(app, services);
     },
 });
 
-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/settings/Debug.vue

@@ -0,0 +1,14 @@
+<template>
+    <Setting
+        title-id="debug-setting"
+        :title="$td('settings.debug', 'Debugging')"
+        :description="$td('settings.debugDescription', 'Enable debugging with [Eruda](https://eruda.liriliri.io/).')"
+    >
+        <Switch v-model="$errors.debug" aria-labelledby="debug-setting" />
+    </Setting>
+</template>
+
+<script setup lang="ts">
+import Setting from '@aerogel/core/components/ui/Setting.vue';
+import Switch from '@aerogel/core/components/ui/Switch.vue';
+</script>

package/src/errors/settings/index.ts

@@ -0,0 +1,10 @@
+import { defineSettings } from '@aerogel/core/services';
+
+import Debug from './Debug.vue';
+
+export default defineSettings([
+    {
+        priority: 10,
+        component: Debug,
+    },
+]);

package/src/errors/utils.ts

@@ -1,5 +1,5 @@
 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[] = [];

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

@@ -1,10 +1,19 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
-
-import { useForm } from './composition';
-import { FormFieldTypes } from '@/main';
-import { numberInput, requiredStringInput } from '@/forms/utils';
-
-describe('Form', () => {
+import { tt } from '@noeldemartin/testing';
+import type { Equals } from '@noeldemartin/utils';
+import type { Expect } from '@noeldemartin/testing';
+
+import {
+    enumInput,
+    numberInput,
+    objectInput,
+    requiredObjectInput,
+    requiredStringInput,
+    stringInput,
+} from '@aerogel/core/forms/utils';
+import { useForm } from '@aerogel/core/utils/composition/forms';
+
+describe('FormController', () => {
 
     it('defines magic fields', () => {
         const form = useForm({
@@ -20,7 +29,7 @@ describe('Form', () => {
         // Arrange
         const form = useForm({
             name: {
-                type: FormFieldTypes.String,
+                type: 'string',
                 rules: 'required',
             },
         });
@@ -38,7 +47,7 @@ describe('Form', () => {
         // Arrange
         const form = useForm({
             name: {
-                type: FormFieldTypes.String,
+                type: 'string',
                 rules: 'required',
             },
         });
@@ -59,11 +68,11 @@ describe('Form', () => {
         // Arrange
         const form = useForm({
             trimmed: {
-                type: FormFieldTypes.String,
+                type: 'string',
                 rules: 'required',
             },
             untrimmed: {
-                type: FormFieldTypes.String,
+                type: 'string',
                 rules: 'required',
                 trim: false,
             },
@@ -83,4 +92,22 @@ describe('Form', () => {
         expect(form.errors).toEqual({ trimmed: ['required'], untrimmed: null });
     });
 
+    it('infers field types', () => {
+        const form = useForm({
+            one: stringInput(),
+            two: requiredStringInput(),
+            three: objectInput(),
+            four: requiredObjectInput<{ foo: string; bar?: number }>(),
+            five: enumInput(['foo', 'bar']),
+        });
+
+        tt<
+            | Expect<Equals<typeof form.one, string | null>>
+            | Expect<Equals<typeof form.two, string>>
+            | Expect<Equals<typeof form.three, object | null>>
+            | Expect<Equals<typeof form.four, { foo: string; bar?: number }>>
+            | Expect<Equals<typeof form.five, 'foo' | 'bar' | null>>
+        >();
+    });
+
 });

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

@@ -1,33 +1,33 @@
 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';
 
-export const FormFieldTypes = {
-    String: 'string',
-    Number: 'number',
-    Boolean: 'boolean',
-    Object: 'object',
-    Date: 'date',
-} as const;
+import { validate, validateType } from './validation';
 
-export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
+export const __valueType: unique symbol = Symbol();
+
+export interface FormFieldDefinition<
+    TType extends FormFieldType = FormFieldType,
+    TRules extends string = string,
+    TValueType = unknown,
+> {
     type: TType;
     trim?: boolean;
     default?: GetFormFieldValue<TType>;
     rules?: TRules;
+    values?: readonly TValueType[];
+    [__valueType]?: TValueType;
 }
 
-export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
-export type FormFieldType = ObjectValues<typeof FormFieldTypes>;
+export type FormFieldType = 'string' | 'enum' | 'number' | 'boolean' | 'object' | 'date';
 export type FormFieldValue = GetFormFieldValue<FormFieldType>;
+export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
 
 export type FormData<T> = {
-    -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
+    -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules, infer TValueType>
         ? TRules extends 'required'
-            ? GetFormFieldValue<TType>
-            : GetFormFieldValue<TType> | null
+            ? GetFormFieldValue<TType, TValueType>
+            : GetFormFieldValue<TType, TValueType> | null
         : never;
 };
 
@@ -35,24 +35,28 @@ export type FormErrors<T> = {
     [k in keyof T]: string[] | null;
 };
 
-export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.String
+export type GetFormFieldValue<TType, TValueType = unknown> = TType extends '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;
-
-const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
+    : TType extends 'number'
+      ? number
+      : TType extends 'boolean'
+        ? boolean
+        : TType extends 'enum'
+          ? TValueType
+          : TType extends 'object'
+            ? TValueType extends object
+                ? TValueType
+                : object
+            : TType extends 'date'
+              ? Date
+              : never;
+
+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>>>;
 
@@ -91,7 +95,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             this._fields[field] ?? fail<FormFieldDefinition>(`Trying to set undefined '${toString(field)}' field`);
 
         this._data[field] =
-            definition.type === FormFieldTypes.String && (definition.trim ?? true)
+            definition.type === 'string' && (definition.trim ?? true)
                 ? (toString(value).trim() as FormData<Fields>[T])
                 : value;
 
@@ -108,16 +112,23 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         return this._fields[field]?.rules?.split('|') ?? [];
     }
 
+    public getFieldType<T extends keyof Fields>(field: T): FormFieldType | null {
+        return this._fields[field]?.type ?? null;
+    }
+
     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);
 
@@ -165,7 +176,7 @@ 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);
         }
@@ -173,7 +184,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         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);
 
@@ -188,6 +199,8 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         const value = this._data[name];
         const rules = definition.rules?.split('|') ?? [];
 
+        errors.push(...validateType(value, definition));
+
         for (const rule of rules) {
             if (rule !== 'required' && (value === null || value === undefined)) {
                 continue;
@@ -204,10 +217,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/index.ts

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

package/src/forms/utils.ts

@@ -1,84 +1,109 @@
-import { FormFieldTypes } from './Form';
-import type { FormFieldDefinition } from './Form';
+import type { FormFieldDefinition } from './FormController';
 
-export function booleanInput(
-    defaultValue?: boolean,
-    options: { rules?: string } = {},
-): FormFieldDefinition<typeof FormFieldTypes.Boolean> {
+export function booleanInput(defaultValue?: boolean, options: { rules?: string } = {}): FormFieldDefinition<'boolean'> {
+    return {
+        default: defaultValue,
+        type: 'boolean',
+        rules: options.rules,
+    };
+}
+
+export function dateInput(defaultValue?: Date, options: { rules?: string } = {}): FormFieldDefinition<'date'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Boolean,
+        type: 'date',
         rules: options.rules,
     };
 }
 
-export function dateInput(
-    defaultValue?: Date,
+export function enumInput<const T extends string>(
+    values: readonly T[],
+    defaultValue?: T,
     options: { rules?: string } = {},
-): FormFieldDefinition<typeof FormFieldTypes.Date> {
+): FormFieldDefinition<'enum', string, T> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Date,
+        type: 'enum',
         rules: options.rules,
+        values,
     };
 }
 
-export function requiredBooleanInput(
-    defaultValue?: boolean,
-): FormFieldDefinition<typeof FormFieldTypes.Boolean, 'required'> {
+export function requiredBooleanInput(defaultValue?: boolean): FormFieldDefinition<'boolean', 'required'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Boolean,
+        type: 'boolean',
         rules: 'required',
     };
 }
 
-export function requiredDateInput(defaultValue?: Date): FormFieldDefinition<typeof FormFieldTypes.Date> {
+export function requiredDateInput(defaultValue?: Date): FormFieldDefinition<'date', 'required'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Date,
+        type: 'date',
         rules: 'required',
     };
 }
 
-export function requiredNumberInput(
-    defaultValue?: number,
-): FormFieldDefinition<typeof FormFieldTypes.Number, 'required'> {
+export function requiredEnumInput<const T extends string>(
+    values: readonly T[],
+    defaultValue?: T,
+): FormFieldDefinition<'enum', 'required', T> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Number,
+        type: 'enum',
         rules: 'required',
+        values,
     };
 }
 
-export function requiredStringInput(
-    defaultValue?: string,
-): FormFieldDefinition<typeof FormFieldTypes.String, 'required'> {
+export function requiredNumberInput(defaultValue?: number): FormFieldDefinition<'number', 'required'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.String,
+        type: 'number',
         rules: 'required',
     };
 }
 
-export function numberInput(
-    defaultValue?: number,
-    options: { rules?: string } = {},
-): FormFieldDefinition<typeof FormFieldTypes.Number> {
+export function requiredObjectInput<T extends object>(defaultValue?: T): FormFieldDefinition<'object', 'required', T> {
+    return {
+        default: defaultValue,
+        type: 'object',
+        rules: 'required',
+    };
+}
+
+export function requiredStringInput(defaultValue?: string): FormFieldDefinition<'string', 'required'> {
+    return {
+        default: defaultValue,
+        type: 'string',
+        rules: 'required',
+    };
+}
+
+export function numberInput(defaultValue?: number, options: { rules?: string } = {}): FormFieldDefinition<'number'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.Number,
+        type: 'number',
         rules: options.rules,
     };
 }
 
-export function stringInput(
-    defaultValue?: string,
+export function objectInput<T extends object>(
+    defaultValue?: T,
     options: { rules?: string } = {},
-): FormFieldDefinition<typeof FormFieldTypes.String> {
+): FormFieldDefinition<'object', string, T> {
+    return {
+        default: defaultValue,
+        type: 'object',
+        rules: options.rules,
+    };
+}
+
+export function stringInput(defaultValue?: string, options: { rules?: string } = {}): FormFieldDefinition<'string'> {
     return {
         default: defaultValue,
-        type: FormFieldTypes.String,
+        type: 'string',
         rules: options.rules,
     };
 }