@aerogel/core 0.0.0-next.980a397d575dcb5ff8c5a0bff769d09f938ea03c → 0.0.0-next.9a1c5ba39a454b316eba36ec7bdf579fed3d95d2

package/src/forms/Form.test.ts

@@ -1,8 +1,9 @@
 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';
+
+import { FormFieldTypes } from './Form';
 
 describe('Form', () => {
 
@@ -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

@@ -1,5 +1,6 @@
-import { MagicObject } from '@noeldemartin/utils';
-import { computed, reactive, readonly, ref } from 'vue';
+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';
 
@@ -8,16 +9,19 @@ export const FormFieldTypes = {
     Number: 'number',
     Boolean: 'boolean',
     Object: 'object',
+    Date: 'date',
 } as const;
 
 export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
     type: TType;
+    trim?: boolean;
     default?: GetFormFieldValue<TType>;
     rules?: TRules;
 }
 
 export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
 export type FormFieldType = ObjectValues<typeof FormFieldTypes>;
+export type FormFieldValue = GetFormFieldValue<FormFieldType>;
 
 export type FormData<T> = {
     -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
@@ -34,15 +38,20 @@ 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
-    : 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();
 
+export type SubmitFormListener = () => unknown;
+export type FocusFormListener = (input: string) => unknown;
+
 export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
 
     public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
@@ -51,6 +60,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     private _data: FormData<Fields>;
     private _submitted: Ref<boolean>;
     private _errors: FormErrors<Fields>;
+    private _listeners: { focus?: FocusFormListener[]; submit?: SubmitFormListener[] } = {};
 
     constructor(fields: Fields) {
         super();
@@ -77,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();
@@ -88,12 +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);
 
@@ -110,32 +137,66 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     public submit(): boolean {
         this._submitted.value = true;
 
-        return this.validate();
+        const valid = this.validate();
+
+        valid && this._listeners['submit']?.forEach((listener) => listener());
+
+        return valid;
     }
 
-    protected __get(property: string): unknown {
+    public on(event: 'focus', listener: FocusFormListener): () => void;
+    public on(event: 'submit', listener: SubmitFormListener): () => void;
+    public on(event: 'focus' | 'submit', listener: FocusFormListener | SubmitFormListener): () => void {
+        this._listeners[event] ??= [];
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this._listeners[event]?.push(listener as any);
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return () => this.off(event as any, listener);
+    }
+
+    public off(event: 'focus', listener: FocusFormListener): void;
+    public off(event: 'submit', listener: SubmitFormListener): void;
+    public off(event: 'focus' | 'submit', listener: FocusFormListener | SubmitFormListener): void {
+        arrayRemove(this._listeners[event] ?? [], listener);
+    }
+
+    public async focus(input: string): Promise<void> {
+        await nextTick();
+
+        this._listeners['focus']?.forEach((listener) => listener(input));
+    }
+
+    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;

package/src/forms/composition.ts

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

package/src/forms/index.ts

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

package/src/forms/utils.ts

@@ -1,10 +1,25 @@
 import { FormFieldTypes } from './Form';
 import type { FormFieldDefinition } from './Form';
 
-export function booleanInput(defaultValue?: boolean): FormFieldDefinition<typeof FormFieldTypes.Boolean> {
+export function booleanInput(
+    defaultValue?: boolean,
+    options: { rules?: string } = {},
+): FormFieldDefinition<typeof FormFieldTypes.Boolean> {
     return {
         default: defaultValue,
         type: FormFieldTypes.Boolean,
+        rules: options.rules,
+    };
+}
+
+export function dateInput(
+    defaultValue?: Date,
+    options: { rules?: string } = {},
+): FormFieldDefinition<typeof FormFieldTypes.Date> {
+    return {
+        default: defaultValue,
+        type: FormFieldTypes.Date,
+        rules: options.rules,
     };
 }
 
@@ -18,6 +33,14 @@ export function requiredBooleanInput(
     };
 }
 
+export function requiredDateInput(defaultValue?: Date): FormFieldDefinition<typeof FormFieldTypes.Date> {
+    return {
+        default: defaultValue,
+        type: FormFieldTypes.Date,
+        rules: 'required',
+    };
+}
+
 export function requiredNumberInput(
     defaultValue?: number,
 ): FormFieldDefinition<typeof FormFieldTypes.Number, 'required'> {
@@ -38,16 +61,24 @@ export function requiredStringInput(
     };
 }
 
-export function numberInput(defaultValue?: number): FormFieldDefinition<typeof FormFieldTypes.Number> {
+export function numberInput(
+    defaultValue?: number,
+    options: { rules?: string } = {},
+): FormFieldDefinition<typeof FormFieldTypes.Number> {
     return {
         default: defaultValue,
         type: FormFieldTypes.Number,
+        rules: options.rules,
     };
 }
 
-export function stringInput(defaultValue?: string): FormFieldDefinition<typeof FormFieldTypes.String> {
+export function stringInput(
+    defaultValue?: string,
+    options: { rules?: string } = {},
+): FormFieldDefinition<typeof FormFieldTypes.String> {
     return {
         default: defaultValue,
         type: FormFieldTypes.String,
+        rules: options.rules,
     };
 }

package/src/forms/validation.ts

@@ -0,0 +1,19 @@
+import { arrayFrom } from '@noeldemartin/utils';
+
+const builtInRules: Record<string, FormFieldValidator> = {
+    required: (value) => (value ? undefined : 'required'),
+};
+
+export type FormFieldValidator<T = unknown> = (value: T) => string | string[] | undefined;
+
+export const validators: Record<string, FormFieldValidator> = { ...builtInRules };
+
+export function defineFormValidationRule<T>(rule: string, validator: FormFieldValidator<T>): void {
+    validators[rule] = validator as FormFieldValidator;
+}
+
+export function validate(value: unknown, rule: string): string[] {
+    const errors = validators[rule]?.(value);
+
+    return errors ? arrayFrom(errors) : [];
+}

package/src/{main.ts → index.ts}

@@ -1,9 +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/jobs/Job.ts

@@ -0,0 +1,147 @@
+import { ListenersManager, PromisedValue, round, tap, toError } from '@noeldemartin/utils';
+import type { Listeners } from '@noeldemartin/utils';
+
+import JobCancelledError from '@aerogel/core/errors/JobCancelledError';
+
+import type { JobListener } from './listeners';
+import type { JobStatus } from './status';
+
+export default abstract class Job<
+    Listener extends JobListener = JobListener,
+    Status extends JobStatus = JobStatus,
+    SerializedStatus extends JobStatus = JobStatus,
+> {
+
+    protected status: Status;
+    protected _listeners: ListenersManager<JobListener>;
+    protected _progress?: number;
+    protected _cancelled?: PromisedValue<void>;
+    protected _started: PromisedValue<void>;
+    protected _completed: PromisedValue<void>;
+
+    constructor() {
+        this.status = this.getInitialStatus();
+        this._listeners = new ListenersManager();
+        this._started = new PromisedValue();
+        this._completed = new PromisedValue();
+    }
+
+    public async start(): Promise<void> {
+        this.beforeStart();
+        this._started.resolve();
+
+        try {
+            await this.updateProgress();
+            await this.run();
+            await this.updateProgress();
+
+            this._completed.resolve();
+        } catch (error) {
+            if (error instanceof JobCancelledError) {
+                return;
+            }
+
+            throw tap(toError(error), (realError) => {
+                this._completed.reject(realError);
+            });
+        }
+    }
+
+    public async cancel(): Promise<void> {
+        this._cancelled = new PromisedValue();
+
+        await this._cancelled;
+    }
+
+    public serialize(): SerializedStatus {
+        return this.serializeStatus(this.status);
+    }
+
+    public get listeners(): Listeners<Listener> {
+        return this._listeners;
+    }
+
+    public get progress(): number {
+        return this._progress ?? 0;
+    }
+
+    public get cancelled(): boolean {
+        return !!this._cancelled?.isResolved();
+    }
+
+    public get started(): Promise<void> {
+        return this._started;
+    }
+
+    public get completed(): Promise<void> {
+        return this._completed;
+    }
+
+    protected abstract run(): Promise<void>;
+
+    protected getInitialStatus(): Status {
+        return { completed: false } as Status;
+    }
+
+    protected beforeStart(): void {
+        if (!this._started.isResolved()) {
+            return;
+        }
+
+        if (this._cancelled) {
+            delete this._progress;
+            delete this._cancelled;
+
+            return;
+        }
+
+        throw new Error('Job already started!');
+    }
+
+    protected assertNotCancelled(): void {
+        if (!this._cancelled) {
+            return;
+        }
+
+        this._cancelled.resolve();
+
+        throw new JobCancelledError();
+    }
+
+    protected calculateCurrentProgress(status?: JobStatus): number {
+        status ??= this.status;
+
+        if (status.completed) {
+            return 1;
+        }
+
+        if (!status.children) {
+            return 0;
+        }
+
+        return round(
+            status.children.reduce((total, child) => total + this.calculateCurrentProgress(child), 0) /
+                status.children.length,
+            2,
+        );
+    }
+
+    protected async updateProgress(update?: (status: Status) => unknown): Promise<void> {
+        await update?.(this.status);
+
+        const progress = this.calculateCurrentProgress();
+
+        if (progress === this._progress) {
+            return;
+        }
+
+        this._progress = progress;
+
+        await this._listeners.emit('onUpdated', progress);
+    }
+
+    protected serializeStatus(status: Status): SerializedStatus {
+        return { ...status } as unknown as SerializedStatus;
+    }
+
+}

package/src/jobs/index.ts

@@ -0,0 +1,10 @@
+import Job from './Job';
+
+export { Job };
+export * from './Job';
+export * from './listeners';
+export * from './status';
+
+export async function dispatch(job: Job): Promise<void> {
+    await job.start();
+}

package/src/jobs/listeners.ts

@@ -0,0 +1,3 @@
+export interface JobListener {
+    onUpdated?(progress: number): unknown;
+}

package/src/jobs/status.ts

@@ -0,0 +1,4 @@
+export interface JobStatus {
+    completed: boolean;
+    children?: JobStatus[];
+}

package/src/lang/DefaultLangProvider.ts

@@ -0,0 +1,46 @@
+import { isDevelopment } from '@noeldemartin/utils';
+
+import type { LangProvider } from './Lang';
+
+export default class DefaultLangProvider implements LangProvider {
+
+    constructor(
+        private locale: string,
+        private fallbackLocale: string,
+    ) {}
+
+    public getLocale(): string {
+        return this.locale;
+    }
+
+    public async setLocale(locale: string): Promise<void> {
+        this.locale = locale;
+    }
+
+    public getFallbackLocale(): string {
+        return this.fallbackLocale;
+    }
+
+    public async setFallbackLocale(fallbackLocale: string): Promise<void> {
+        this.fallbackLocale = fallbackLocale;
+    }
+
+    public getLocales(): string[] {
+        return ['en'];
+    }
+
+    public translate(key: string): string {
+        // eslint-disable-next-line no-console
+        isDevelopment() && console.warn('Lang provider is missing');
+
+        return key;
+    }
+
+    public translateWithDefault(_: string, defaultMessage: string): string {
+        // eslint-disable-next-line no-console
+        isDevelopment() && console.warn('Lang provider is missing');
+
+        return defaultMessage;
+    }
+
+}

package/src/lang/Lang.state.ts

@@ -0,0 +1,11 @@
+import { defineServiceState } from '@aerogel/core/services/Service';
+
+export default defineServiceState({
+    name: 'lang',
+    persist: ['locale', 'fallbackLocale'],
+    initialState: {
+        locale: null as string | null,
+        locales: ['en'],
+        fallbackLocale: 'en',
+    },
+});

package/src/lang/Lang.ts

@@ -1,10 +1,16 @@
-import { facade, toString } from '@noeldemartin/utils';
+import { facade } from '@noeldemartin/utils';
 
-import App from '@/services/App';
-import Service from '@/services/Service';
+import DefaultLangProvider from './DefaultLangProvider';
+import Service from './Lang.state';
 
 export interface LangProvider {
-    translate(key: string, parameters?: Record<string, unknown>): string;
+    getLocale(): string;
+    setLocale(locale: string): Promise<void>;
+    getFallbackLocale(): string;
+    setFallbackLocale(fallbackLocale: string): Promise<void>;
+    getLocales(): string[];
+    translate(key: string, parameters?: Record<string, unknown> | number): string;
+    translateWithDefault(key: string, defaultMessage: string, parameters?: Record<string, unknown> | number): string;
 }
 
 export class LangService extends Service {
@@ -14,47 +20,56 @@ export class LangService extends Service {
     constructor() {
         super();
 
-        this.provider = {
-            translate: (key) => {
-                // eslint-disable-next-line no-console
-                App.development && console.warn('Lang provider is missing');
-
-                return key;
-            },
-        };
+        this.provider = new DefaultLangProvider(
+            this.getState('locale') ?? this.getBrowserLocale(),
+            this.getState('fallbackLocale'),
+        );
     }
 
-    public setProvider(provider: LangProvider): void {
+    public async setProvider(provider: LangProvider): Promise<void> {
         this.provider = provider;
+        this.locales = provider.getLocales();
+
+        await provider.setLocale(this.locale ?? this.getBrowserLocale());
+        await provider.setFallbackLocale(this.fallbackLocale);
     }
 
-    public translate(key: string, parameters?: Record<string, unknown>): string {
+    public translate(key: string, parameters?: Record<string, unknown> | number): string {
         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,
+        defaultMessage: string,
+        parameters: Record<string, unknown> | number = {},
     ): string {
-        defaultMessage ??= defaultMessageOrParameters as string;
+        return this.provider.translateWithDefault(key, defaultMessage, parameters);
+    }
 
-        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters ?? {};
-        const message = this.provider.translate(key, parameters) ?? key;
+    public getBrowserLocale(): string {
+        const locales = this.getState('locales');
 
-        if (message === key) {
-            return Object.entries(parameters).reduce(
-                (renderedMessage, [name, value]) =>
-                    renderedMessage.replace(new RegExp(`\\{\\s*${name}\\s*\\}`, 'g'), toString(value)),
-                defaultMessage,
-            );
+        return navigator.languages.find((locale) => locales.includes(locale)) ?? 'en';
+    }
+
+    protected override async boot(): Promise<void> {
+        if (!globalThis.document) {
+            return;
         }
 
-        return message;
+        this.requireStore().$subscribe(
+            async () => {
+                await this.provider.setLocale(this.locale ?? this.getBrowserLocale());
+                await this.provider.setFallbackLocale(this.fallbackLocale);
+
+                this.locale
+                    ? document.querySelector('html')?.setAttribute('lang', this.locale)
+                    : document.querySelector('html')?.removeAttribute('lang');
+            },
+            { immediate: true },
+        );
     }
 
 }
 
-export default facade(new LangService());
+export default facade(LangService);