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

package/src/forms/Form.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;
 }
@@ -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,6 +104,10 @@ 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 };
     }
@@ -158,7 +170,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             return super.__get(property);
         }
 
-        return this._data[property];
+        return this.getFieldValue(property);
     }
 
     protected __set(property: string, value: unknown): void {
@@ -168,14 +180,20 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             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/index.ts

@@ -1,4 +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,17 +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): FormFieldDefinition<typeof FormFieldTypes.Date> {
+export function dateInput(
+    defaultValue?: Date,
+    options: { rules?: string } = {},
+): FormFieldDefinition<typeof FormFieldTypes.Date> {
     return {
         default: defaultValue,
         type: FormFieldTypes.Date,
+        rules: options.rules,
     };
 }
 
@@ -53,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/jobs/Job.ts

@@ -1,5 +1,147 @@
-export default abstract class Job {
+import { ListenersManager, PromisedValue, round, tap, toError } from '@noeldemartin/utils';
+import type { Listeners } from '@noeldemartin/utils';
 
-    public abstract run(): Promise<void>;
+import JobCancelledError from '@/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

@@ -1,7 +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.run();
+    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/Lang.ts

@@ -53,6 +53,10 @@ export class LangService extends Service {
     }
 
     protected async boot(): Promise<void> {
+        if (!globalThis.document) {
+            return;
+        }
+
         this.requireStore().$subscribe(
             async () => {
                 await this.provider.setLocale(this.locale ?? this.getBrowserLocale());

package/src/services/App.state.ts

@@ -1,5 +1,7 @@
 import Aerogel from 'virtual:aerogel';
 
+import type { App } from 'vue';
+
 import { defineServiceState } from '@/services/Service';
 import type { Plugin } from '@/plugins/Plugin';
 
@@ -7,24 +9,30 @@ export default defineServiceState({
     name: 'app',
     initialState: {
         plugins: {} as Record<string, Plugin>,
+        instance: null as App | null,
         environment: Aerogel.environment,
         version: Aerogel.version,
         sourceUrl: Aerogel.sourceUrl,
     },
     computed: {
         development: (state) => state.environment === 'development',
+        staging: (state) => state.environment === 'staging',
         testing: (state) => state.environment === 'test' || state.environment === 'testing',
         versionName(state): string {
             if (this.development) {
                 return 'dev.' + Aerogel.sourceHash.toString().substring(0, 7);
             }
 
+            if (this.staging) {
+                return 'staging.' + Aerogel.sourceHash.toString().substring(0, 7);
+            }
+
             return `v${state.version}`;
         },
         versionUrl(state): string {
             return (
                 state.sourceUrl +
-                (this.development ? `/tree/${Aerogel.sourceHash}` : `/releases/tag/${this.versionName}`)
+                (this.development || this.staging ? `/tree/${Aerogel.sourceHash}` : `/releases/tag/${this.versionName}`)
             );
         },
     },

package/src/services/App.ts

@@ -4,6 +4,7 @@ import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@
 
 import Events from '@/services/Events';
 import type { Plugin } from '@/plugins';
+import type { Services } from '@/services';
 
 import Service from './App.state';
 
@@ -40,6 +41,10 @@ export class AppService extends Service {
         return (this.plugins[name] as T) ?? null;
     }
 
+    public service<T extends keyof Services>(name: T): Services[T] | null {
+        return this.instance?.config.globalProperties[name] ?? null;
+    }
+
     protected async boot(): Promise<void> {
         Events.once('application-ready', () => this.ready.resolve());
         Events.once('application-mounted', () => this.mounted.resolve());

package/src/services/Events.ts

@@ -4,7 +4,7 @@ import Service from '@/services/Service';
 
 export interface EventsPayload {}
 export interface EventListenerOptions {
-    priority: number;
+    priority: EventListenerPriority;
 }
 export type AerogelGlobalEvents = Partial<{ [Event in EventWithoutPayload]: () => unknown }> &
     Partial<{ [Event in EventWithPayload]: EventListener<EventsPayload[Event]> }>;
@@ -26,6 +26,8 @@ export const EventListenerPriorities = {
     High: 256,
 } as const;
 
+export type EventListenerPriority = (typeof EventListenerPriorities)[keyof typeof EventListenerPriorities];
+
 export class EventsService extends Service {
 
     private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
@@ -48,19 +50,27 @@ export class EventsService extends Service {
 
     /* eslint-disable max-len */
     public on<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): () => void;
+    public on<Event extends EventWithoutPayload>(event: Event, priority: EventListenerPriority, listener: () => unknown): () => void; // prettier-ignore
     public on<Event extends EventWithoutPayload>(event: Event, options: Partial<EventListenerOptions>, listener: () => unknown): () => void; // prettier-ignore
     public on<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
+    public on<Event extends EventWithPayload>(event: Event, priority: EventListenerPriority, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
     public on<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
     public on<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
+    public on<Event extends string>(event: UnknownEvent<Event>, priority: EventListenerPriority, listener: EventListener): () => void; // prettier-ignore
     public on<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
     /* eslint-enable max-len */
 
     public on(
         event: string,
-        optionsOrListener: Partial<EventListenerOptions> | EventListener,
+        optionsOrListener: Partial<EventListenerOptions> | EventListenerPriority | EventListener,
         listener?: EventListener,
     ): () => void {
-        const options = typeof optionsOrListener === 'function' ? {} : optionsOrListener;
+        const options =
+            typeof optionsOrListener === 'function'
+                ? {}
+                : typeof optionsOrListener === 'number'
+                    ? { priority: optionsOrListener }
+                    : optionsOrListener;
         const handler = typeof optionsOrListener === 'function' ? optionsOrListener : (listener as EventListener);
 
         this.registerListener(event, options, handler);