@aerogel/core 0.0.0-next.d547095ca85c86c1e41f5c7fa170d0ba856c3f4d → 0.0.0-next.d7394c3aa6aac799b0971e63819a8713d05a5123

package/src/forms/Form.test.ts

@@ -55,4 +55,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,5 @@
-import { MagicObject } from '@noeldemartin/utils';
-import { computed, reactive, readonly, ref } from 'vue';
+import { MagicObject, arrayRemove, fail, toString } from '@noeldemartin/utils';
+import { computed, nextTick, reactive, readonly, ref } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
 import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
 
@@ -8,10 +8,12 @@ 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;
 }
@@ -40,10 +42,15 @@ export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.Strin
     ? 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>>>;
@@ -52,6 +59,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();
@@ -78,7 +86,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();
@@ -89,6 +103,14 @@ 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);
@@ -111,7 +133,35 @@ 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;
+    }
+
+    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 __get(property: string): unknown {
@@ -119,7 +169,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 {
@@ -129,7 +179,7 @@ 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 {

package/src/forms/index.ts

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

package/src/forms/utils.ts

@@ -8,6 +8,13 @@ export function booleanInput(defaultValue?: boolean): FormFieldDefinition<typeof
     };
 }
 
+export function dateInput(defaultValue?: Date): FormFieldDefinition<typeof FormFieldTypes.Date> {
+    return {
+        default: defaultValue,
+        type: FormFieldTypes.Date,
+    };
+}
+
 export function requiredBooleanInput(
     defaultValue?: boolean,
 ): FormFieldDefinition<typeof FormFieldTypes.Boolean, 'required'> {
@@ -18,6 +25,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'> {

package/src/lang/DefaultLangProvider.ts

@@ -0,0 +1,43 @@
+import App from '@/services/App';
+
+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
+        App.development && console.warn('Lang provider is missing');
+
+        return key;
+    }
+
+    public translateWithDefault(_: string, defaultMessage: string): string {
+        // eslint-disable-next-line no-console
+        App.development && console.warn('Lang provider is missing');
+
+        return defaultMessage;
+    }
+
+}

package/src/lang/Lang.state.ts

@@ -0,0 +1,11 @@
+import { defineServiceState } from '@/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,11 +1,16 @@
 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;
-    translateWithDefault(key: string, defaultMessage: 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 {
@@ -15,34 +20,52 @@ 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;
-            },
-            translateWithDefault: (_, defaultMessage) => {
-                // eslint-disable-next-line no-console
-                App.development && console.warn('Lang provider is missing');
-
-                return defaultMessage;
-            },
-        };
+        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, parameters: Record<string, unknown> = {}): string {
+    public translateWithDefault(
+        key: string,
+        defaultMessage: string,
+        parameters: Record<string, unknown> | number = {},
+    ): string {
         return this.provider.translateWithDefault(key, defaultMessage, parameters);
     }
 
+    public getBrowserLocale(): string {
+        const locales = this.getState('locales');
+
+        return navigator.languages.find((locale) => locales.includes(locale)) ?? 'en';
+    }
+
+    protected async boot(): Promise<void> {
+        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(LangService);

package/src/services/App.state.ts

@@ -8,10 +8,24 @@ export default defineServiceState({
     initialState: {
         plugins: {} as Record<string, Plugin>,
         environment: Aerogel.environment,
+        version: Aerogel.version,
         sourceUrl: Aerogel.sourceUrl,
     },
     computed: {
         development: (state) => state.environment === 'development',
         testing: (state) => state.environment === 'test' || state.environment === 'testing',
+        versionName(state): string {
+            if (this.development) {
+                return 'dev.' + 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}`)
+            );
+        },
     },
 });

package/src/services/App.ts

@@ -1,3 +1,5 @@
+import Aerogel from 'virtual:aerogel';
+
 import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
 
 import Events from '@/services/Events';
@@ -7,6 +9,7 @@ import Service from './App.state';
 
 export class AppService extends Service {
 
+    public readonly name = Aerogel.name;
     public readonly ready = new PromisedValue<void>();
     public readonly mounted = new PromisedValue<void>();
 

package/src/services/Cache.ts

@@ -0,0 +1,43 @@
+import { PromisedValue, facade, tap } from '@noeldemartin/utils';
+
+import Service from '@/services/Service';
+
+export class CacheService extends Service {
+
+    private cache?: PromisedValue<Cache> = undefined;
+
+    public async get(url: string): Promise<Response | null> {
+        const cache = await this.open();
+        const response = await cache.match(url);
+
+        return response ?? null;
+    }
+
+    public async store(url: string, response: Response): Promise<void> {
+        const cache = await this.open();
+
+        await cache.put(url, response);
+    }
+
+    public async replace(url: string, response: Response): Promise<void> {
+        const cache = await this.open();
+        const keys = await cache.keys(url);
+
+        if (keys.length === 0) {
+            return;
+        }
+
+        await cache.put(url, response);
+    }
+
+    protected async open(): Promise<Cache> {
+        return (this.cache =
+            this.cache ??
+            tap(new PromisedValue<Cache>(), (cache) => {
+                caches.open('app').then((instance) => cache.resolve(instance));
+            }));
+    }
+
+}
+
+export default facade(CacheService);

package/src/services/Service.ts

@@ -1,4 +1,4 @@
-import { MagicObject, PromisedValue, Storage, isEmpty, objectDeepClone, objectOnly } from '@noeldemartin/utils';
+import { MagicObject, PromisedValue, Storage, fail, isEmpty, objectDeepClone, objectOnly } from '@noeldemartin/utils';
 import type { Constructor } from '@noeldemartin/utils';
 import type { MaybeRef } from 'vue';
 import type { Store } from 'pinia';
@@ -91,7 +91,7 @@ export default class Service<
     protected _name: string;
     private _booted: PromisedValue<void>;
     private _computedStateKeys: Set<keyof State>;
-    private _store: Store | false;
+    private _store: Store<string, State, ComputedState, {}> | false;
 
     constructor() {
         super();
@@ -250,4 +250,12 @@ export default class Service<
         Storage.set(this._name, objectOnly(this.getState(), persist));
     }
 
+    protected requireStore(): Store<string, State, ComputedState, {}> {
+        if (!this._store) {
+            return fail(`Failed getting '${this._name}' store`);
+        }
+
+        return this._store;
+    }
+
 }

package/src/services/index.ts

@@ -3,16 +3,18 @@ import type { App as VueApp } from 'vue';
 import { definePlugin } from '@/plugins';
 
 import App from './App';
+import Cache from './Cache';
 import Events from './Events';
 import Service from './Service';
 import { getPiniaStore } from './store';
 
 export * from './App';
+export * from './Cache';
 export * from './Events';
 export * from './Service';
 export * from './store';
 
-export { App, Events, Service };
+export { App, Cache, Events, Service };
 
 const defaultServices = {
     $app: App,

package/src/testing/setup.ts

@@ -0,0 +1,25 @@
+import { mock, tap } from '@noeldemartin/utils';
+import { beforeEach, vi } from 'vitest';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+tap(globalThis, (global: any) => {
+    global.jest = vi;
+    global.navigator = { languages: ['en'] };
+    global.window = mock<Window>({
+        matchMedia: () =>
+            mock<MediaQueryList>({
+                addEventListener: () => null,
+            }),
+    });
+    global.localStorage = mock<Storage>({
+        getItem: () => null,
+        setItem: () => null,
+    });
+});
+
+beforeEach(() => {
+    vi.stubGlobal('document', {
+        querySelector: () => null,
+        getElementById: () => null,
+    });
+});

package/src/ui/UI.state.ts

@@ -2,6 +2,8 @@ import type { Component } from 'vue';
 
 import { defineServiceState } from '@/services/Service';
 
+import { Layouts, getCurrentLayout } from './utils';
+
 export interface Modal<T = unknown> {
     id: string;
     properties: Record<string, unknown>;
@@ -28,5 +30,10 @@ export default defineServiceState({
     initialState: {
         modals: [] as Modal[],
         snackbars: [] as Snackbar[],
+        layout: getCurrentLayout(),
+    },
+    computed: {
+        mobile: ({ layout }) => layout === Layouts.Mobile,
+        desktop: ({ layout }) => layout === Layouts.Desktop,
     },
 });

package/src/ui/UI.ts

@@ -4,10 +4,12 @@ import type { Component } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
 
 import Events from '@/services/Events';
+import type { Color } from '@/components/constants';
 import type { SnackbarAction, SnackbarColor } from '@/components/headless/snackbars';
 import type { AGAlertModalProps, AGConfirmModalProps, AGLoadingModalProps, AGPromptModalProps } from '@/components';
 
 import Service from './UI.state';
+import { MOBILE_BREAKPOINT, getCurrentLayout } from './utils';
 import type { Modal, ModalComponent, Snackbar } from './UI.state';
 
 interface ModalCallbacks<T = unknown> {
@@ -34,7 +36,9 @@ export type UIComponent = ObjectValues<typeof UIComponents>;
 
 export interface ConfirmOptions {
     acceptText?: string;
+    acceptColor?: Color;
     cancelText?: string;
+    cancelColor?: Color;
 }
 
 export interface PromptOptions {
@@ -42,7 +46,10 @@ export interface PromptOptions {
     defaultValue?: string;
     placeholder?: string;
     acceptText?: string;
+    acceptColor?: Color;
     cancelText?: string;
+    cancelColor?: Color;
+    trim?: boolean;
 }
 
 export interface ShowSnackbarOptions {
@@ -115,6 +122,7 @@ export class UIService extends Service {
         messageOrOptions?: string | PromptOptions,
         options?: PromptOptions,
     ): Promise<string | null> {
+        const trim = options?.trim ?? true;
         const getProperties = (): AGPromptModalProps => {
             if (typeof messageOrOptions !== 'string') {
                 return {
@@ -134,14 +142,18 @@ export class UIService extends Service {
             this.requireComponent(UIComponents.PromptModal),
             getProperties(),
         );
-        const result = await modal.beforeClose;
+        const rawResult = await modal.beforeClose;
+        const result = trim && typeof rawResult === 'string' ? rawResult?.trim() : rawResult;
 
         return result ?? null;
     }
 
-    public async loading<T>(operation: Promise<T>): Promise<T>;
-    public async loading<T>(message: string, operation: Promise<T>): Promise<T>;
-    public async loading<T>(messageOrOperation: string | Promise<T>, operation?: Promise<T>): Promise<T> {
+    public async loading<T>(operation: Promise<T> | (() => T)): Promise<T>;
+    public async loading<T>(message: string, operation: Promise<T> | (() => T)): Promise<T>;
+    public async loading<T>(
+        messageOrOperation: string | Promise<T> | (() => T),
+        operation?: Promise<T> | (() => T),
+    ): Promise<T> {
         const getProperties = (): AGLoadingModalProps => {
             if (typeof messageOrOperation !== 'string') {
                 return {};
@@ -153,7 +165,8 @@ export class UIService extends Service {
         const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
 
         try {
-            operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
+            operation = typeof messageOrOperation === 'string' ? (operation as () => T) : messageOrOperation;
+            operation = typeof operation === 'function' ? Promise.resolve(operation()) : operation;
 
             const [result] = await Promise.all([operation, after({ seconds: 1 })]);
 
@@ -223,6 +236,7 @@ export class UIService extends Service {
     protected async boot(): Promise<void> {
         this.watchModalEvents();
         this.watchMountedEvent();
+        this.watchWindowMedia();
     }
 
     private watchModalEvents(): void {
@@ -268,6 +282,12 @@ export class UIService extends Service {
         });
     }
 
+    private watchWindowMedia(): void {
+        const media = window.matchMedia(`(min-width: ${MOBILE_BREAKPOINT}px)`);
+
+        media.addEventListener('change', () => this.setState({ layout: getCurrentLayout() }));
+    }
+
 }
 
 export default facade(UIService);

package/src/ui/index.ts

@@ -16,6 +16,7 @@ import type { UIComponent } from './UI';
 const services = { $ui: UI };
 
 export * from './UI';
+export * from './utils';
 export { default as UI } from './UI';
 
 export type UIServices = typeof services;

package/src/ui/utils.ts

@@ -0,0 +1,16 @@
+export const MOBILE_BREAKPOINT = 768;
+
+export const Layouts = {
+    Mobile: 'mobile',
+    Desktop: 'desktop',
+} as const;
+
+export type Layout = (typeof Layouts)[keyof typeof Layouts];
+
+export function getCurrentLayout(): Layout {
+    if (window.innerWidth > MOBILE_BREAKPOINT) {
+        return Layouts.Desktop;
+    }
+
+    return Layouts.Mobile;
+}

package/src/utils/vue.ts

@@ -73,10 +73,12 @@ export function injectOrFail<T>(key: InjectionKey<T> | string, errorMessage?: st
     return inject(key) ?? fail(errorMessage ?? `Could not resolve '${key}' injection key`);
 }
 
-export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null> {
+export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null>;
+export function mixedProp<T>(type: PropType<T>, defaultValue: T): OptionalProp<T>;
+export function mixedProp<T>(type?: PropType<T>, defaultValue?: T): OptionalProp<T | null> {
     return {
         type,
-        default: null,
+        default: defaultValue ?? null,
     };
 }
 

package/vite.config.ts

@@ -4,7 +4,10 @@ import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
-    test: { clearMocks: true },
+    test: {
+        clearMocks: true,
+        setupFiles: ['./src/testing/setup.ts'],
+    },
     plugins: [Aerogel(), Icons()],
     resolve: {
         alias: {