@aerogel/core 0.0.0-next.f16bd1d894543c5303039c49f6f33488a1ffe931 → 0.0.0-next.f7d6218c6788b7d93b1f58d848fc11cd0a351798

package/src/services/Service.ts

@@ -1,63 +1,114 @@
-import { MagicObject, PromisedValue, Storage, isEmpty, objectDeepClone, objectOnly } from '@noeldemartin/utils';
-import type { Constructor } from '@noeldemartin/utils';
+import {
+    MagicObject,
+    PromisedValue,
+    Storage,
+    arrayFrom,
+    fail,
+    isEmpty,
+    objectDeepClone,
+    objectOnly,
+} from '@noeldemartin/utils';
+import type { Constructor, Nullable } from '@noeldemartin/utils';
 import type { Store } from 'pinia';
 
-import ServiceBootError from '@/errors/ServiceBootError';
-import { defineServiceStore } from '@/services/store';
+import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
+import { defineServiceStore } from '@aerogel/core/services/store';
+import type { Unref } from '@aerogel/core/utils/vue';
 
 export type ServiceState = Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
 export type DefaultServiceState = any; // eslint-disable-line @typescript-eslint/no-explicit-any
 export type ServiceConstructor<T extends Service = Service> = Constructor<T> & typeof Service;
 
 export type ComputedStateDefinition<TState extends ServiceState, TComputedState extends ServiceState> = {
-    [K in keyof TComputedState]: (state: TState) => TComputedState[K];
+    [K in keyof TComputedState]: (state: Unref<TState>) => TComputedState[K];
 } & ThisType<{
     readonly [K in keyof TComputedState]: TComputedState[K];
 }>;
 
+export type StateWatchers<TService extends Service, TState extends ServiceState> = {
+    [K in keyof TState]?: (this: TService, value: TState[K], oldValue: TState[K]) => unknown;
+};
+
+export type ServiceWithState<
+    State extends ServiceState = ServiceState,
+    ComputedState extends ServiceState = {},
+    ServiceStorage = Partial<State>,
+> = Constructor<Unref<State>> &
+    Constructor<ComputedState> &
+    Constructor<Service<Unref<State>, ComputedState, Unref<ServiceStorage>>>;
+
 export function defineServiceState<
     State extends ServiceState = ServiceState,
-    ComputedState extends ServiceState = {}
+    ComputedState extends ServiceState = {},
+    ServiceStorage = Partial<State>,
 >(options: {
     name: string;
-    initialState: State;
+    initialState: State | (() => State);
     persist?: (keyof State)[];
+    watch?: StateWatchers<Service, State>;
     computed?: ComputedStateDefinition<State, ComputedState>;
-    serialize?: (state: Partial<State>) => Partial<State>;
-}): Constructor<State> & Constructor<ComputedState> & Constructor<Service<State, ComputedState, Partial<State>>> {
-    return class extends Service<State, ComputedState> {
+    serialize?: (state: Partial<State>) => ServiceStorage;
+    restore?: (state: ServiceStorage) => Partial<State>;
+}): ServiceWithState<State, ComputedState, ServiceStorage> {
+    return class extends Service<Unref<State>, ComputedState, ServiceStorage> {
 
-        public static persist = (options.persist as string[]) ?? [];
+        public static override persist = (options.persist as string[]) ?? [];
 
-        protected usesStore(): boolean {
+        protected override usesStore(): boolean {
             return true;
         }
 
-        protected getName(): string | null {
+        protected override getName(): string | null {
             return options.name ?? null;
         }
 
-        protected getInitialState(): State {
-            return options.initialState;
+        protected override getInitialState(): Unref<State> {
+            if (typeof options.initialState === 'function') {
+                return options.initialState();
+            }
+
+            return Object.entries(options.initialState).reduce((state, [key, value]) => {
+                try {
+                    value = structuredClone(value);
+                } catch (error) {
+                    // eslint-disable-next-line no-console
+                    console.warn(
+                        `Could not clone '${key}' state from ${this.getName()} service, ` +
+                            'this may cause problems if you\'re using multiple instances of the service ' +
+                            '(for example, in unit tests).\n' +
+                            'To fix this problem, declare your initialState as a function instead.',
+                    );
+                }
+
+                state[key as keyof State] = value;
+
+                return state;
+            }, {} as Unref<State>);
+        }
+
+        protected override getComputedStateDefinition(): ComputedStateDefinition<Unref<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<Unref<State>, ComputedState>;
+        }
+
+        protected override getStateWatchers(): StateWatchers<Service, Unref<State>> {
+            return (options.watch ?? {}) as StateWatchers<Service, Unref<State>>;
         }
 
-        protected getComputedStateDefinition(): ComputedStateDefinition<State, ComputedState> {
-            return options.computed ?? ({} as ComputedStateDefinition<State, ComputedState>);
+        protected override serializePersistedState(state: Partial<State>): ServiceStorage {
+            return options.serialize?.(state) ?? (state as ServiceStorage);
         }
 
-        protected serializePersistedState(state: Partial<State>): Partial<State> {
-            return options.serialize?.(state) ?? state;
+        protected override deserializePersistedState(state: ServiceStorage): Partial<State> {
+            return options.restore?.(state) ?? (state as Partial<State>);
         }
     
-    } as unknown as Constructor<State> &
-        Constructor<ComputedState> &
-        Constructor<Service<State, ComputedState, Partial<State>>>;
+    } as unknown as ServiceWithState<State, ComputedState, ServiceStorage>;
 }
 
 export default class Service<
     State extends ServiceState = DefaultServiceState,
     ComputedState extends ServiceState = {},
-    ServiceStorage extends Partial<State> = Partial<State>
+    ServiceStorage = Partial<State>,
 > extends MagicObject {
 
     public static persist: string[] = [];
@@ -65,7 +116,8 @@ export default class Service<
     protected _name: string;
     private _booted: PromisedValue<void>;
     private _computedStateKeys: Set<keyof State>;
-    private _store?: Store | false;
+    private _watchers: StateWatchers<Service, State>;
+    private _store: Store<string, State, ComputedState, {}> | false;
 
     constructor() {
         super();
@@ -75,6 +127,7 @@ export default class Service<
         this._name = this.getName() ?? new.target.name;
         this._booted = new PromisedValue();
         this._computedStateKeys = new Set(Object.keys(getters));
+        this._watchers = this.getStateWatchers();
         this._store =
             this.usesStore() &&
             defineServiceStore(this._name, {
@@ -89,11 +142,18 @@ export default class Service<
         return this._booted;
     }
 
+    public override static<T extends typeof Service>(): T;
+    public override static<T extends typeof Service, K extends keyof T>(property: K): T[K];
+    public override static<T extends typeof Service, K extends keyof T>(property?: K): T | T[K] {
+        return super.static<T, K>(property as K);
+    }
+
     public launch(): Promise<void> {
         const handleError = (error: unknown) => this._booted.reject(new ServiceBootError(this._name, error));
 
         try {
-            this.boot()
+            this.frameworkBoot()
+                .then(() => this.boot())
                 .then(() => this._booted.resolve())
                 .catch(handleError);
         } catch (error) {
@@ -103,6 +163,10 @@ export default class Service<
         return this._booted;
     }
 
+    public hasPersistedState(): boolean {
+        return Storage.has(this._name);
+    }
+
     public hasState<P extends keyof State>(property: P): boolean {
         if (!this._store) {
             return false;
@@ -118,10 +182,10 @@ export default class Service<
         const store = this._store as any;
 
         if (property) {
-            return store ? store[property] : undefined;
+            return store ? store[property] : (undefined as State[P]);
         }
 
-        return store ? store : {};
+        return store ? store : ({} as State);
     }
 
     public setState<P extends keyof State>(property: P, value: State[P]): void;
@@ -131,16 +195,31 @@ export default class Service<
             return;
         }
 
-        const state = (
-            typeof stateOrProperty === 'string' ? { [stateOrProperty]: value } : stateOrProperty
-        ) as Partial<State>;
+        const update = typeof stateOrProperty === 'string' ? { [stateOrProperty]: value } : stateOrProperty;
+        const old = objectOnly(this._store.$state as State, Object.keys(update));
+
+        Object.assign(this._store.$state, update);
+        this.onStateUpdated(update as Partial<State>, old as Partial<State>);
+    }
 
-        Object.assign(this._store.$state, state);
+    public updatePersistedState<T extends keyof State>(key: T): void;
+    public updatePersistedState<T extends keyof State>(keys: T[]): void;
+    public updatePersistedState<T extends keyof State>(keyOrKeys: T | T[]): void {
+        if (!this._store) {
+            return;
+        }
 
-        this.onStateUpdated(state);
+        const keys = arrayFrom(keyOrKeys) as Array<keyof State>;
+        const state = objectOnly(this._store.$state as State, keys);
+
+        if (isEmpty(state)) {
+            return;
+        }
+
+        this.onPersistentStateUpdated(state);
     }
 
-    protected __get(property: string): unknown {
+    protected override __get(property: string): unknown {
         if (this.hasState(property)) {
             return this.getState(property);
         }
@@ -148,20 +227,34 @@ export default class Service<
         return super.__get(property);
     }
 
-    protected __set(property: string, value: unknown): void {
+    protected override __set(property: string, value: unknown): void {
         this.setState({ [property]: value } as Partial<State>);
     }
 
-    protected onStateUpdated(state: Partial<State>): void {
-        // TODO fix this.static()
-        const persist = (this.constructor as unknown as { persist: string[] }).persist;
-        const persisted = objectOnly(state, persist);
+    protected onStateUpdated(update: Partial<State>, old: Partial<State>): void {
+        const persisted = objectOnly(update, this.static('persist'));
 
-        if (isEmpty(persisted)) {
-            return;
+        if (!isEmpty(persisted)) {
+            this.onPersistentStateUpdated(persisted as Partial<State>);
         }
 
-        const storage = Storage.require<ServiceStorage>(this._name);
+        for (const property in update) {
+            const watcher = this._watchers[property] as Nullable<(value: unknown, oldValue: unknown) => unknown>;
+
+            if (!watcher || update[property] === old[property]) {
+                continue;
+            }
+
+            watcher.call(this, update[property], old[property]);
+        }
+    }
+
+    protected onPersistentStateUpdated(persisted: Partial<State>): void {
+        const storage = Storage.get<ServiceStorage>(this._name);
+
+        if (!storage) {
+            return;
+        }
 
         Storage.set(this._name, {
             ...storage,
@@ -185,30 +278,47 @@ export default class Service<
         return {} as ComputedStateDefinition<State, ComputedState>;
     }
 
-    protected serializePersistedState(state: Partial<State>): Partial<State> {
-        return state;
+    protected getStateWatchers(): StateWatchers<Service, State> {
+        return {};
     }
 
-    protected async boot(): Promise<void> {
+    protected serializePersistedState(state: Partial<State>): ServiceStorage {
+        return state as ServiceStorage;
+    }
+
+    protected deserializePersistedState(state: ServiceStorage): Partial<State> {
+        return state as Partial<State>;
+    }
+
+    protected async frameworkBoot(): Promise<void> {
         this.restorePersistedState();
     }
 
-    protected restorePersistedState(): void {
-        // TODO fix this.static()
-        const persist = (this.constructor as unknown as { persist: string[] }).persist;
+    protected async boot(): Promise<void> {
+        // Placeholder for overrides, don't place any functionality here.
+    }
 
-        if (!this.usesStore() || isEmpty(persist)) {
+    protected restorePersistedState(): void {
+        if (!this.usesStore() || isEmpty(this.static('persist'))) {
             return;
         }
 
         if (Storage.has(this._name)) {
             const persisted = Storage.require<ServiceStorage>(this._name);
-            this.setState(persisted);
+            this.setState(this.deserializePersistedState(persisted));
 
             return;
         }
 
-        Storage.set(this._name, objectOnly(this.getState(), persist));
+        Storage.set(this._name, objectOnly(this.getState(), this.static('persist')));
+    }
+
+    protected requireStore(): Store<string, State, ComputedState, {}> {
+        if (!this._store) {
+            return fail(`Failed getting '${this._name}' store`);
+        }
+
+        return this._store;
     }
 
 }

package/src/services/Storage.ts

@@ -0,0 +1,20 @@
+import { facade } from '@noeldemartin/utils';
+
+import Events from '@aerogel/core/services/Events';
+import Service from '@aerogel/core/services/Service';
+
+export class StorageService extends Service {
+
+    public async purge(): Promise<void> {
+        await Events.emit('purge-storage');
+    }
+
+}
+
+export default facade(StorageService);
+
+declare module '@aerogel/core/services/Events' {
+    export interface EventsPayload {
+        'purge-storage': void;
+    }
+}

package/src/services/index.ts

@@ -1,36 +1,49 @@
-import type { App as VueApp } from 'vue';
+import type { App as AppInstance } from 'vue';
 
-import { definePlugin } from '@/plugins';
+import { definePlugin } from '@aerogel/core/plugins';
+import { isDevelopment, isTesting } from '@noeldemartin/utils';
 
 import App from './App';
+import Cache from './Cache';
 import Events from './Events';
 import Service from './Service';
+import Storage from './Storage';
 import { getPiniaStore } from './store';
+import type { AppSetting } from './App.state';
 
 export * from './App';
+export * from './Cache';
 export * from './Events';
 export * from './Service';
+export * from './store';
+export * from './utils';
 
-export { App, Events, Service };
+export { App, Cache, Events, Storage, Service };
 
 const defaultServices = {
     $app: App,
     $events: Events,
+    $storage: Storage,
 };
 
 export type DefaultServices = typeof defaultServices;
 
 export interface Services extends DefaultServices {}
 
-export async function bootServices(app: VueApp, services: Record<string, Service>): Promise<void> {
+export async function bootServices(app: AppInstance, services: Record<string, Service>): Promise<void> {
     await Promise.all(
-        Object.entries(services).map(async ([_, service]) => {
-            // eslint-disable-next-line no-console
-            await service.launch().catch((error) => console.error(error));
+        Object.entries(services).map(async ([name, service]) => {
+            await service
+                .launch()
+                .catch((error) => app.config.errorHandler?.(error, null, `Failed launching ${name}.`));
         }),
     );
 
     Object.assign(app.config.globalProperties, services);
+
+    if (isDevelopment() || isTesting()) {
+        Object.assign(globalThis, services);
+    }
 }
 
 export default definePlugin({
@@ -41,17 +54,19 @@ export default definePlugin({
         };
 
         app.use(getPiniaStore());
+        options.settings?.forEach((setting) => App.addSetting(setting));
 
         await bootServices(app, services);
     },
 });
 
-declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+declare module '@aerogel/core/bootstrap/options' {
+    export interface AerogelOptions {
         services?: Record<string, Service>;
+        settings?: AppSetting[];
     }
 }
 
-declare module '@vue/runtime-core' {
+declare module 'vue' {
     interface ComponentCustomProperties extends Services {}
 }

package/src/services/store.ts

@@ -1,16 +1,19 @@
+import { tap } from '@noeldemartin/utils';
 import { createPinia, defineStore, setActivePinia } from 'pinia';
 import type { DefineStoreOptions, Pinia, StateTree, Store, _GettersTree } from 'pinia';
 
 let _store: Pinia | null = null;
 
 function initializePiniaStore(): Pinia {
-    if (!_store) {
-        _store = createPinia();
+    return _store ?? resetPiniaStore();
+}
 
-        setActivePinia(_store);
-    }
+export function resetPiniaStore(): Pinia {
+    return tap(createPinia(), (store) => {
+        _store = store;
 
-    return _store;
+        setActivePinia(store);
+    });
 }
 
 export function getPiniaStore(): Pinia {

package/src/services/utils.ts

@@ -0,0 +1,18 @@
+import { objectOnly } from '@noeldemartin/utils';
+
+export type Replace<
+    TOriginal extends Record<string, unknown>,
+    TReplacements extends Partial<Record<keyof TOriginal, unknown>>,
+> = {
+    [K in keyof TOriginal]: TReplacements extends Record<K, infer Replacement> ? Replacement : TOriginal[K];
+};
+
+export function replaceExisting<
+    TOriginal extends Record<string, unknown>,
+    TReplacements extends Partial<Record<keyof TOriginal, unknown>>,
+>(original: TOriginal, replacements: TReplacements): Replace<TOriginal, TReplacements> {
+    return {
+        ...original,
+        ...objectOnly(replacements, Object.keys(original)),
+    } as Replace<TOriginal, TReplacements>;
+}

package/src/testing/index.ts

@@ -0,0 +1,30 @@
+import { isTesting } from '@noeldemartin/utils';
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import Events from '@aerogel/core/services/Events';
+import { App } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
+import type { Services } from '@aerogel/core/services';
+
+export interface AerogelTestingRuntime {
+    on: (typeof Events)['on'];
+    service<T extends keyof Services>(name: T): Services[T] | null;
+}
+
+export default definePlugin({
+    async install() {
+        if (!isTesting()) {
+            return;
+        }
+
+        globalThis.testingRuntime = {
+            on: ((...args: GetClosureArgs<(typeof Events)['on']>) => Events.on(...args)) as (typeof Events)['on'],
+            service: (name) => App.service(name),
+        };
+    },
+});
+
+declare global {
+    // eslint-disable-next-line no-var
+    var testingRuntime: AerogelTestingRuntime | undefined;
+}

package/src/testing/setup.ts

@@ -0,0 +1,11 @@
+import { FakeLocalStorage } from '@noeldemartin/testing';
+import { beforeEach, vi } from 'vitest';
+
+vi.mock('dompurify', async () => {
+    return { default: { sanitize: (html: string) => html } };
+});
+
+beforeEach(() => {
+    FakeLocalStorage.reset();
+    FakeLocalStorage.patchGlobal();
+});

package/src/ui/UI.state.ts

@@ -1,23 +1,19 @@
 import type { Component } from 'vue';
 
-import { defineServiceState } from '@/services/Service';
+import { defineServiceState } from '@aerogel/core/services/Service';
 
-export interface Modal<T = unknown> {
+import { Layouts, getCurrentLayout } from './utils';
+
+export interface UIModal<T = unknown> {
     id: string;
     properties: Record<string, unknown>;
     component: Component;
+    closing: boolean;
     beforeClose: Promise<T | undefined>;
     afterClose: Promise<T | undefined>;
 }
 
-export interface ModalComponent<
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    Properties extends Record<string, unknown> = Record<string, unknown>,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    Result = unknown
-> {}
-
-export interface Snackbar {
+export interface UIToast {
     id: string;
     component: Component;
     properties: Record<string, unknown>;
@@ -26,7 +22,13 @@ export interface Snackbar {
 export default defineServiceState({
     name: 'ui',
     initialState: {
-        modals: [] as Modal[],
-        snackbars: [] as Snackbar[],
+        modals: [] as UIModal[],
+        toasts: [] as UIToast[],
+        layout: getCurrentLayout(),
+    },
+    computed: {
+        desktop: ({ layout }) => layout === Layouts.Desktop,
+        mobile: ({ layout }) => layout === Layouts.Mobile,
+        openModals: ({ modals }) => modals.filter(({ closing }) => !closing),
     },
 });