@aerogel/core 0.0.0-next.7f6ed5a1f91688a86bf5ede2adc465e4fd6cfdea → 0.0.0-next.8323c60b905020dcb3bd9d4b0bc8d9b6529e1082

package/src/services/Events.ts

@@ -1,12 +1,15 @@
-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';
+import Service from '@aerogel/core/services/Service';
 
 export interface EventsPayload {}
+export interface EventListenerOptions {
+    priority: EventListenerPriority;
+}
+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;
 
 export type EventWithoutPayload = {
     [K in keyof EventsPayload]: EventsPayload[K] extends void ? K : never;
@@ -16,70 +19,141 @@ 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 type EventListenerPriority = (typeof EventListenerPriorities)[keyof typeof EventListenerPriorities];
+
 export class EventsService extends Service {
 
-    private listeners: Record<string, FluentArray<EventListener>> = {};
+    private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
+
+    protected override async boot(): Promise<void> {
+        Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this.on(event as any, 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 string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
-    public on(event: string, listener: EventListener): () => void {
-        (this.listeners[event] ??= arr<EventListener>([])).push(listener);
-
-        return () => this.off(event, listener);
+    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
+    /* eslint-enable max-len */
+
+    public on(
+        event: string,
+        optionsOrListener: Partial<EventListenerOptions> | EventListenerPriority | EventListener,
+        listener?: EventListener,
+    ): () => void {
+        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);
+
+        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 string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
-    public once(event: string, listener: EventListener): () => 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
+    /* 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,50 +1,160 @@
-import { MagicObject, PromisedValue } from '@noeldemartin/utils';
-import { reactive } from 'vue';
-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 ServiceBootError from '@aerogel/core/errors/ServiceBootError';
+import { appNamespace } from '@aerogel/core/utils/app';
+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 = {};
+export type DefaultServiceState = any; // eslint-disable-line @typescript-eslint/no-explicit-any
 export type ServiceConstructor<T extends Service = Service> = Constructor<T> & typeof Service;
 
-export function defineServiceState<State extends ServiceState>(options: {
-    initialState: State;
-}): Constructor<State> & ServiceConstructor {
-    return class extends Service<State> {
+export type ComputedStateDefinition<TState extends ServiceState, TComputedState extends ServiceState> = {
+    [K in keyof TComputedState]: (state: Unref<TState>) => TComputedState[K];
+} & ThisType<{
+    readonly [K in keyof TComputedState]: TComputedState[K];
+}>;
 
-        protected getInitialState(): State {
-            return options.initialState;
+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 = {},
+    ServiceStorage = Partial<State>,
+>(options: {
+    name: string;
+    initialState: State | (() => State);
+    persist?: (keyof State)[];
+    watch?: StateWatchers<Service, State>;
+    computed?: ComputedStateDefinition<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 override persist = (options.persist as string[]) ?? [];
+
+        protected override usesStore(): boolean {
+            return true;
+        }
+
+        protected override getName(): string | null {
+            return options.name ?? null;
+        }
+
+        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 override serializePersistedState(state: Partial<State>): ServiceStorage {
+            return options.serialize?.(state) ?? (state as ServiceStorage);
+        }
+
+        protected override deserializePersistedState(state: ServiceStorage): Partial<State> {
+            return options.restore?.(state) ?? (state as Partial<State>);
         }
     
-    } as unknown as Constructor<State> & ServiceConstructor;
+    } as unknown as ServiceWithState<State, ComputedState, ServiceStorage>;
 }
 
-export default class Service<State extends ServiceState = DefaultServiceState> extends MagicObject {
+export default class Service<
+    State extends ServiceState = DefaultServiceState,
+    ComputedState extends ServiceState = {},
+    ServiceStorage = Partial<State>,
+> extends MagicObject {
+
+    public static persist: string[] = [];
 
-    protected _namespace: string;
+    protected _name: string;
     private _booted: PromisedValue<void>;
-    private _state: State;
+    private _computedStateKeys: Set<keyof State>;
+    private _watchers: StateWatchers<Service, State>;
+    private _store: Store<string, State, ComputedState, {}> | false;
 
     constructor() {
         super();
 
-        this._namespace = new.target.name;
+        const getters = this.getComputedStateDefinition();
+
+        this._name = this.getName() ?? new.target.name;
         this._booted = new PromisedValue();
-        this._state = reactive(this.getInitialState());
+        this._computedStateKeys = new Set(Object.keys(getters));
+        this._watchers = this.getStateWatchers();
+        this._store =
+            this.usesStore() &&
+            defineServiceStore(this._name, {
+                state: () => this.getInitialState(),
+
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                getters: getters as any,
+            });
     }
 
     public get booted(): PromisedValue<void> {
         return this._booted;
     }
 
-    public launch(namespace?: string): Promise<void> {
-        const handleError = (error: unknown) => this._booted.reject(new ServiceBootError(this._namespace, error));
+    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);
+    }
 
-        this._namespace = namespace ?? this._namespace;
+    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) {
@@ -54,38 +164,166 @@ export default class Service<State extends ServiceState = DefaultServiceState> e
         return this._booted;
     }
 
-    protected __get(property: string): unknown {
-        if (!this.hasState(property)) {
-            return super.__get(property);
+    public hasPersistedState(): boolean {
+        return Storage.has(this.storageKey);
+    }
+
+    public hasState<P extends keyof State>(property: P): boolean {
+        if (!this._store) {
+            return false;
+        }
+
+        return property in this._store.$state || this._computedStateKeys.has(property);
+    }
+
+    public getState(): State;
+    public getState<P extends keyof State>(property: P): State[P];
+    public getState<P extends keyof State>(property?: P): State | State[P] {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const store = this._store as any;
+
+        if (property) {
+            return store ? store[property] : (undefined as State[P]);
+        }
+
+        return store ? store : ({} as State);
+    }
+
+    public setState<P extends keyof State>(property: P, value: State[P]): void;
+    public setState(state: Partial<State>): void;
+    public setState<P extends keyof State>(stateOrProperty: P | Partial<State>, value?: State[P]): void {
+        if (!this._store) {
+            return;
+        }
+
+        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>);
+    }
+
+    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 override __get(property: string): unknown {
+        if (this.hasState(property)) {
+            return this.getState(property);
         }
 
-        return this.getState(property);
+        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 hasState<P extends keyof State>(property: P): boolean {
-        return property in this._state;
+    protected get storageKey(): string {
+        return `${appNamespace()}:${this._name}`;
+    }
+
+    protected onStateUpdated(update: Partial<State>, old: Partial<State>): void {
+        const persisted = objectOnly(update, this.static('persist'));
+
+        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.storageKey);
+
+        if (!storage) {
+            return;
+        }
+
+        Storage.set(this.storageKey, {
+            ...storage,
+            ...this.serializePersistedState(objectDeepClone(persisted) as Partial<State>),
+        });
     }
 
-    protected getState(): State;
-    protected getState<P extends keyof State>(property: P): State[P];
-    protected getState<P extends keyof State>(property?: P): State | State[P] {
-        return property ? this._state[property] : this._state;
+    protected usesStore(): boolean {
+        return false;
     }
 
-    protected setState(state: Partial<State>): void {
-        Object.assign(this._state, state);
+    protected getName(): string | null {
+        return null;
     }
 
     protected getInitialState(): State {
         return {} as State;
     }
 
+    protected getComputedStateDefinition(): ComputedStateDefinition<State, ComputedState> {
+        return {} as ComputedStateDefinition<State, ComputedState>;
+    }
+
+    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.restorePersistedState();
+    }
+
     protected async boot(): Promise<void> {
-        //
+        // Placeholder for overrides, don't place any functionality here.
+    }
+
+    protected restorePersistedState(): void {
+        if (!this.usesStore() || isEmpty(this.static('persist'))) {
+            return;
+        }
+
+        if (Storage.has(this.storageKey)) {
+            const persisted = Storage.require<ServiceStorage>(this.storageKey);
+            this.setState(this.deserializePersistedState(persisted));
+
+            return;
+        }
+
+        Storage.set(this.storageKey, 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,35 +1,72 @@
-import type { App } from 'vue';
+import type { App as AppInstance } from 'vue';
 
+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 { defineBootstrapHook } from '@/bootstrap/hooks';
+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 { 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: App, 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 ([name, service]) => {
-            // eslint-disable-next-line no-console
-            await service.launch(name.slice(1)).catch((error) => console.error(error));
+            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 defineBootstrapHook((app) => bootServices(app, defaultServices));
+export default definePlugin({
+    async install(app, options) {
+        const services = {
+            ...defaultServices,
+            ...options.services,
+        };
+
+        app.use(getPiniaStore());
+        options.settings?.forEach((setting) => App.addSetting(setting));
+
+        await bootServices(app, services);
+    },
+});
+
+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 {}
 }