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

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/Events.test.ts

@@ -0,0 +1,39 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+
+import Events, { EventListenerPriorities } from './Events';
+
+describe('Events', () => {
+
+    beforeEach(() => void Events.reset());
+
+    it('registers listeners', async () => {
+        // Arrange
+        let counter = 0;
+
+        Events.on('trigger', () => counter++);
+
+        // Act
+        await Events.emit('trigger');
+        await Events.emit('trigger');
+        await Events.emit('trigger');
+
+        // Assert
+        expect(counter).toEqual(3);
+    });
+
+    it('triggers listeners by priority', async () => {
+        // Arrange
+        const storage: string[] = [];
+
+        Events.on('trigger', () => storage.push('second'));
+        Events.on('trigger', { priority: EventListenerPriorities.Low }, () => storage.push('third'));
+        Events.on('trigger', { priority: EventListenerPriorities.High }, () => storage.push('first'));
+
+        // Act
+        await Events.emit('trigger');
+
+        // Assert
+        expect(storage).toEqual(['first', 'second', 'third']);
+    });
+
+});

package/src/services/Events.ts

@@ -1,9 +1,13 @@
-import { arr, facade, tap } from '@noeldemartin/utils';
-import type { FluentArray } from '@noeldemartin/utils';
+import { arrayRemove, facade, fail, tap } from '@noeldemartin/utils';
 
 import Service from '@/services/Service';
 
 export interface EventsPayload {}
+export interface EventListenerOptions {
+    priority: number;
+}
+export type AerogelGlobalEvents = Partial<{ [Event in EventWithoutPayload]: () => unknown }> &
+    Partial<{ [Event in EventWithPayload]: EventListener<EventsPayload[Event]> }>;
 
 export type EventListener<T = unknown> = (payload: T) => unknown;
 export type UnknownEvent<T> = T extends keyof EventsPayload ? never : T;
@@ -16,70 +20,136 @@ export type EventWithPayload = {
     [K in keyof EventsPayload]: EventsPayload[K] extends void ? never : K;
 }[keyof EventsPayload];
 
+export const EventListenerPriorities = {
+    Low: -256,
+    Default: 0,
+    High: 256,
+} as const;
+
 export class EventsService extends Service {
 
-    private listeners: Record<string, FluentArray<EventListener>> = {};
+    private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
+
+    protected async boot(): Promise<void> {
+        Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
+            this.on(event as string, listener as EventListener));
+    }
 
     public emit<Event extends EventWithoutPayload>(event: Event): Promise<void>;
     public emit<Event extends EventWithPayload>(event: Event, payload: EventsPayload[Event]): Promise<void>;
     public emit<Event extends string>(event: UnknownEvent<Event>, payload?: unknown): Promise<void>;
     public async emit(event: string, payload?: unknown): Promise<void> {
-        const listeners = [...(this.listeners[event] ?? [])];
+        const listeners = this.listeners[event] ?? { priorities: [], handlers: {} };
 
-        await Promise.all(listeners.map((listener) => listener(payload)) ?? []);
+        for (const priority of listeners.priorities) {
+            await Promise.all(listeners.handlers[priority]?.map((listener) => listener(payload)) ?? []);
+        }
     }
 
+    /* eslint-disable max-len */
     public on<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): () => void;
-    public on<Event extends EventWithPayload>(
-        event: Event,
-        listener: EventListener<EventsPayload[Event]>
-    ): () => void | void;
-
+    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, 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: string, listener: EventListener): () => void {
-        (this.listeners[event] ??= arr<EventListener>([])).push(listener);
+    public on<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
+    /* eslint-enable max-len */
 
-        return () => this.off(event, listener);
+    public on(
+        event: string,
+        optionsOrListener: Partial<EventListenerOptions> | EventListener,
+        listener?: EventListener,
+    ): () => void {
+        const options = typeof optionsOrListener === 'function' ? {} : optionsOrListener;
+        const handler = typeof optionsOrListener === 'function' ? optionsOrListener : (listener as EventListener);
+
+        this.registerListener(event, options, handler);
+
+        return () => this.off(event, handler);
     }
 
+    /* eslint-disable max-len */
     public once<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): () => void;
-    public once<Event extends EventWithPayload>(
-        event: Event,
-        listener: EventListener<EventsPayload[Event]>
-    ): () => void | void;
-
+    public once<Event extends EventWithoutPayload>(event: Event, options: Partial<EventListenerOptions>, listener: () => unknown): () => void; // prettier-ignore
+    public once<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
+    public once<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
     public once<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
-    public once(event: string, listener: EventListener): () => void {
+    public once<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
+    /* eslint-enable max-len */
+
+    public once(
+        event: string,
+        optionsOrListener: Partial<EventListenerOptions> | EventListener,
+        listener?: EventListener,
+    ): () => void {
         let onceListener: EventListener | null = null;
+        const options = typeof optionsOrListener === 'function' ? {} : optionsOrListener;
+        const handler = typeof optionsOrListener === 'function' ? optionsOrListener : (listener as EventListener);
 
         return tap(
             () => onceListener && this.off(event, onceListener),
             (off) => {
-                (this.listeners[event] ??= arr<EventListener>([])).push(
-                    (onceListener = (...args) => {
-                        off();
+                onceListener = (...args) => {
+                    off();
 
-                        return listener(...args);
-                    }),
-                );
+                    return handler(...args);
+                };
+
+                this.registerListener(event, options, handler);
             },
         );
     }
 
     public off(event: string, listener: EventListener): void {
-        const eventListeners = this.listeners[event];
+        const listeners = this.listeners[event];
 
-        if (!eventListeners) {
+        if (!listeners) {
             return;
         }
 
-        eventListeners.remove(listener);
+        const priorities = [...listeners.priorities];
+
+        for (const priority of priorities) {
+            arrayRemove(listeners.handlers[priority] ?? [], listener);
 
-        if (eventListeners.isEmpty()) {
+            if (listeners.handlers[priority]?.length === 0) {
+                delete listeners.handlers[priority];
+                arrayRemove(listeners.priorities, priority);
+            }
+        }
+
+        if (listeners.priorities.length === 0) {
             delete this.listeners[event];
         }
     }
 
+    protected registerListener(event: string, options: Partial<EventListenerOptions>, handler: EventListener): void {
+        const priority = options.priority ?? 0;
+
+        if (!(event in this.listeners)) {
+            this.listeners[event] = { priorities: [], handlers: {} };
+        }
+
+        const priorities =
+            this.listeners[event]?.priorities ?? fail<number[]>(`priorities missing for event '${event}'`);
+        const handlers =
+            this.listeners[event]?.handlers ??
+            fail<Record<number, EventListener[]>>(`handlers missing for event '${event}'`);
+
+        if (!priorities.includes(priority)) {
+            priorities.push(priority);
+            priorities.sort((a, b) => b - a);
+            handlers[priority] = [];
+        }
+
+        handlers[priority]?.push(handler);
+    }
+
 }
 
-export default facade(new EventsService());
+export default facade(EventsService);
+
+declare global {
+    // eslint-disable-next-line no-var
+    var __aerogelEvents__: AerogelGlobalEvents | undefined;
+}

package/src/services/Service.ts

@@ -1,5 +1,6 @@
-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';
 
 import ServiceBootError from '@/errors/ServiceBootError';
@@ -8,9 +9,12 @@ import { defineServiceStore } from '@/services/store';
 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: TState) => TComputedState[K];
+    [K in keyof TComputedState]: (state: UnrefServiceState<TState>) => TComputedState[K];
 } & ThisType<{
     readonly [K in keyof TComputedState]: TComputedState[K];
 }>;
@@ -20,12 +24,14 @@ export function defineServiceState<
     ComputedState extends ServiceState = {}
 >(options: {
     name: string;
-    initialState: State;
+    initialState: State | (() => State);
     persist?: (keyof 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> {
+}): Constructor<UnrefServiceState<State>> &
+    Constructor<ComputedState> &
+    Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>> {
+    return class extends Service<UnrefServiceState<State>, ComputedState> {
 
         public static persist = (options.persist as string[]) ?? [];
 
@@ -37,21 +43,41 @@ export function defineServiceState<
             return options.name ?? null;
         }
 
-        protected getInitialState(): State {
-            return options.initialState;
+        protected getInitialState(): UnrefServiceState<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 UnrefServiceState<State>);
         }
 
-        protected getComputedStateDefinition(): ComputedStateDefinition<State, ComputedState> {
-            return options.computed ?? ({} as ComputedStateDefinition<State, ComputedState>);
+        protected getComputedStateDefinition(): ComputedStateDefinition<UnrefServiceState<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<UnrefServiceState<State>, ComputedState>;
         }
 
         protected serializePersistedState(state: Partial<State>): Partial<State> {
             return options.serialize?.(state) ?? state;
         }
-    
-    } as unknown as Constructor<State> &
+
+    } as unknown as Constructor<UnrefServiceState<State>> &
         Constructor<ComputedState> &
-        Constructor<Service<State, ComputedState, Partial<State>>>;
+        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
 }
 
 export default class Service<
@@ -65,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();
@@ -104,6 +130,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;
@@ -162,7 +192,11 @@ export default class Service<
             return;
         }
 
-        const storage = Storage.require<ServiceStorage>(this._name);
+        const storage = Storage.get<ServiceStorage>(this._name);
+
+        if (!storage) {
+            return;
+        }
 
         Storage.set(this._name, {
             ...storage,
@@ -191,14 +225,14 @@ export default class Service<
     }
 
     protected async frameworkBoot(): Promise<void> {
-        this.restorePersistedState();
+        this.initializePersistedState();
     }
 
     protected async boot(): Promise<void> {
-        // Override.
+        // Placeholder for overrides, don't place any functionality here.
     }
 
-    protected restorePersistedState(): void {
+    protected initializePersistedState(): void {
         // TODO fix this.static()
         const persist = (this.constructor as unknown as { persist: string[] }).persist;
 
@@ -216,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,15 +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,
@@ -50,7 +53,7 @@ export default definePlugin({
 });
 
 declare module '@/bootstrap/options' {
-    interface AerogelOptions {
+    export interface AerogelOptions {
         services?: Record<string, Service>;
     }
 }

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/testing/index.ts

@@ -0,0 +1,25 @@
+import type { GetClosureArgs } from '@noeldemartin/utils';
+
+import Events from '@/services/Events';
+import { definePlugin } from '@/plugins';
+
+export interface AerogelTestingRuntime {
+    on: (typeof Events)['on'];
+}
+
+export default definePlugin({
+    async install() {
+        if (import.meta.env.MODE !== 'testing') {
+            return;
+        }
+
+        globalThis.testingRuntime = {
+            on: ((...args: GetClosureArgs<(typeof Events)['on']>) => Events.on(...args)) as (typeof Events)['on'],
+        };
+    },
+});
+
+declare global {
+    // eslint-disable-next-line no-var
+    var testingRuntime: AerogelTestingRuntime | undefined;
+}

package/src/testing/setup.ts

@@ -0,0 +1,19 @@
+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.localStorage = mock<Storage>({
+        getItem: () => null,
+        setItem: () => null,
+    });
+});
+
+beforeEach(() => {
+    vi.stubGlobal('document', {
+        querySelector: () => null,
+        getElementById: () => null,
+    });
+});