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

package/src/services/Service.ts

@@ -1,37 +1,56 @@
-import { MagicObject, PromisedValue, Storage, fail, isEmpty, objectDeepClone, objectOnly } from '@noeldemartin/utils';
-import type { Constructor } from '@noeldemartin/utils';
-import type { MaybeRef } from 'vue';
+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 type { Unref } from '@/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 UnrefServiceState<State extends ServiceState> = {
-    [K in keyof State]: State[K] extends MaybeRef<infer T> ? T : State[K];
-};
 
 export type ComputedStateDefinition<TState extends ServiceState, TComputedState extends ServiceState> = {
-    [K in keyof TComputedState]: (state: UnrefServiceState<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 | (() => State);
     persist?: (keyof State)[];
+    watch?: StateWatchers<Service, State>;
     computed?: ComputedStateDefinition<State, ComputedState>;
-    serialize?: (state: Partial<State>) => Partial<State>;
-}): Constructor<UnrefServiceState<State>> &
-    Constructor<ComputedState> &
-    Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>> {
-    return class extends Service<UnrefServiceState<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[]) ?? [];
 
@@ -43,7 +62,7 @@ export function defineServiceState<
             return options.name ?? null;
         }
 
-        protected getInitialState(): UnrefServiceState<State> {
+        protected getInitialState(): Unref<State> {
             if (typeof options.initialState === 'function') {
                 return options.initialState();
             }
@@ -64,26 +83,32 @@ export function defineServiceState<
                 state[key as keyof State] = value;
 
                 return state;
-            }, {} as UnrefServiceState<State>);
+            }, {} as Unref<State>);
         }
 
-        protected getComputedStateDefinition(): ComputedStateDefinition<UnrefServiceState<State>, ComputedState> {
-            return (options.computed ?? {}) as ComputedStateDefinition<UnrefServiceState<State>, ComputedState>;
+        protected getComputedStateDefinition(): ComputedStateDefinition<Unref<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<Unref<State>, ComputedState>;
         }
 
-        protected serializePersistedState(state: Partial<State>): Partial<State> {
-            return options.serialize?.(state) ?? state;
+        protected getStateWatchers(): StateWatchers<Service, Unref<State>> {
+            return (options.watch ?? {}) as StateWatchers<Service, Unref<State>>;
         }
 
-    } as unknown as Constructor<UnrefServiceState<State>> &
-        Constructor<ComputedState> &
-        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
+        protected serializePersistedState(state: Partial<State>): ServiceStorage {
+            return options.serialize?.(state) ?? (state as ServiceStorage);
+        }
+
+        protected deserializePersistedState(state: ServiceStorage): Partial<State> {
+            return options.restore?.(state) ?? (state as 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[] = [];
@@ -91,6 +116,7 @@ export default class Service<
     protected _name: string;
     private _booted: PromisedValue<void>;
     private _computedStateKeys: Set<keyof State>;
+    private _watchers: StateWatchers<Service, State>;
     private _store: Store<string, State, ComputedState, {}> | false;
 
     constructor() {
@@ -101,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, {
@@ -115,6 +142,12 @@ export default class Service<
         return this._booted;
     }
 
+    public static<T extends typeof Service>(): T;
+    public static<T extends typeof Service, K extends keyof T>(property: K): T[K];
+    public 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));
 
@@ -162,13 +195,28 @@ 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, state);
+        Object.assign(this._store.$state, update);
+        this.onStateUpdated(update as Partial<State>, old as Partial<State>);
+    }
 
-        this.onStateUpdated(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;
+        }
+
+        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 {
@@ -183,15 +231,25 @@ export default class Service<
         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>);
         }
 
+        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) {
@@ -220,34 +278,39 @@ 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 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.initializePersistedState();
+        this.restorePersistedState();
     }
 
     protected async boot(): Promise<void> {
         // Placeholder for overrides, don't place any functionality here.
     }
 
-    protected initializePersistedState(): void {
-        // TODO fix this.static()
-        const persist = (this.constructor as unknown as { persist: string[] }).persist;
-
-        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, {}> {

package/src/services/Storage.ts

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

package/src/services/index.ts

@@ -6,6 +6,7 @@ import App from './App';
 import Cache from './Cache';
 import Events from './Events';
 import Service from './Service';
+import Storage from './Storage';
 import { getPiniaStore } from './store';
 
 export * from './App';
@@ -13,12 +14,14 @@ export * from './Cache';
 export * from './Events';
 export * from './Service';
 export * from './store';
+export * from './utils';
 
-export { App, Cache, Events, Service };
+export { App, Cache, Events, Storage, Service };
 
 const defaultServices = {
     $app: App,
     $events: Events,
+    $storage: Storage,
 };
 
 export type DefaultServices = typeof defaultServices;
@@ -36,7 +39,9 @@ export async function bootServices(app: VueApp, services: Record<string, Service
 
     Object.assign(app.config.globalProperties, services);
 
-    App.development && Object.assign(window, services);
+    if (App.development || App.testing) {
+        Object.assign(globalThis, services);
+    }
 }
 
 export default definePlugin({

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/setup.ts

@@ -1,16 +1,24 @@
-import { mock, tap } from '@noeldemartin/utils';
+import { mock, tap, toString } from '@noeldemartin/utils';
 import { beforeEach, vi } from 'vitest';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 tap(globalThis, (global: any) => {
+    const localStorage: Record<string, string> = {};
+
     global.jest = vi;
     global.navigator = { languages: ['en'] };
     global.localStorage = mock<Storage>({
-        getItem: () => null,
-        setItem: () => null,
+        getItem: (key) => localStorage[key] ?? null,
+        setItem(key, value) {
+            localStorage[key] = toString(value);
+        },
     });
 });
 
+vi.mock('dompurify', async () => {
+    return { default: { sanitize: (html: string) => html } };
+});
+
 beforeEach(() => {
     vi.stubGlobal('document', {
         querySelector: () => 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,
     },
 });