@aerogel/core 0.0.0-next.a3194a101ceda87a7033fa5e283e046bad6f4bfc → 0.0.0-next.a3d64a2a6fe8f788cc0fdd63d5ad52404d5058d4

package/src/plugins/Plugin.ts

@@ -1,6 +1,6 @@
 import type { App } from 'vue';
 
-import type { AerogelOptions } from '@/bootstrap/options';
+import type { AerogelOptions } from '@aerogel/core/bootstrap/options';
 
 export interface Plugin {
     name?: string;

package/src/plugins/index.ts

@@ -1,6 +1,6 @@
 import type { GetClosureArgs } from '@noeldemartin/utils';
 
-import App from '@/services/App';
+import App from '@aerogel/core/services/App';
 
 import type { Plugin } from './Plugin';
 
@@ -13,13 +13,16 @@ export function definePlugin<T extends Plugin>(plugin: T): T {
 export async function installPlugins(plugins: Plugin[], ...args: GetClosureArgs<Plugin['install']>): Promise<void> {
     App.setState(
         'plugins',
-        plugins.reduce((pluginsMap, plugin) => {
-            if (plugin.name) {
-                pluginsMap[plugin.name] = plugin;
-            }
+        plugins.reduce(
+            (pluginsMap, plugin) => {
+                if (plugin.name) {
+                    pluginsMap[plugin.name] = plugin;
+                }
 
-            return pluginsMap;
-        }, {} as Record<string, Plugin>),
+                return pluginsMap;
+            },
+            {} as Record<string, Plugin>,
+        ),
     );
 
     await Promise.all(plugins.map((plugin) => plugin.install(...args)) ?? []);

package/src/services/App.state.ts

@@ -1,17 +1,50 @@
 import Aerogel from 'virtual:aerogel';
 
-import { defineServiceState } from '@/services/Service';
-import type { Plugin } from '@/plugins/Plugin';
+import { getEnv } from '@noeldemartin/utils';
+import type { App, Component } from 'vue';
+
+import { defineServiceState } from '@aerogel/core/services/Service';
+import type { Plugin } from '@aerogel/core/plugins/Plugin';
+
+export interface AppSetting {
+    component: Component;
+    priority: number;
+}
+
+export function defineSettings<T extends AppSetting[]>(settings: T): T {
+    return settings;
+}
 
 export default defineServiceState({
     name: 'app',
     initialState: {
         plugins: {} as Record<string, Plugin>,
-        environment: Aerogel.environment,
+        instance: null as App | null,
+        environment: getEnv() ?? 'development',
+        version: Aerogel.version,
         sourceUrl: Aerogel.sourceUrl,
+        settings: [] as AppSetting[],
     },
     computed: {
         development: (state) => state.environment === 'development',
+        staging: (state) => state.environment === 'staging',
         testing: (state) => state.environment === 'test' || state.environment === 'testing',
+        versionName(state): string {
+            if (this.development) {
+                return 'dev.' + Aerogel.sourceHash.toString().substring(0, 7);
+            }
+
+            if (this.staging) {
+                return 'staging.' + Aerogel.sourceHash.toString().substring(0, 7);
+            }
+
+            return `v${state.version}`;
+        },
+        versionUrl(state): string {
+            return (
+                state.sourceUrl +
+                (this.development || this.staging ? `/tree/${Aerogel.sourceHash}` : `/releases/tag/${this.versionName}`)
+            );
+        },
     },
 });

package/src/services/App.ts

@@ -1,12 +1,20 @@
+import Aerogel from 'virtual:aerogel';
+
 import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
+import { markRaw } from 'vue';
 
-import Events from '@/services/Events';
-import type { Plugin } from '@/plugins';
+import Events from '@aerogel/core/services/Events';
+import type { Plugin } from '@aerogel/core/plugins';
+import type { AppSetting, Services } from '@aerogel/core/services';
 
 import Service from './App.state';
 
+export { defineSettings } from './App.state';
+export type { AppSetting } 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>();
 
@@ -18,6 +26,10 @@ export class AppService extends Service {
         return this.mounted.isResolved();
     }
 
+    public addSetting(setting: AppSetting): void {
+        this.settings.push(markRaw(setting));
+    }
+
     public async whenReady<T>(callback: () => T): Promise<T> {
         const result = await this.ready.then(callback);
 
@@ -37,7 +49,11 @@ export class AppService extends Service {
         return (this.plugins[name] as T) ?? null;
     }
 
-    protected async boot(): Promise<void> {
+    public service<T extends keyof Services>(name: T): Services[T] | null {
+        return this.instance?.config.globalProperties[name] ?? null;
+    }
+
+    protected override async boot(): Promise<void> {
         Events.once('application-ready', () => this.ready.resolve());
         Events.once('application-mounted', () => this.mounted.resolve());
     }

package/src/services/Cache.ts

@@ -0,0 +1,43 @@
+import { PromisedValue, facade, tap } from '@noeldemartin/utils';
+
+import Service from '@aerogel/core/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

@@ -10,12 +10,12 @@ describe('Events', () => {
         // Arrange
         let counter = 0;
 
-        Events.on('trigger', () => counter++);
+        Events.on('application-mounted', () => counter++);
 
         // Act
-        await Events.emit('trigger');
-        await Events.emit('trigger');
-        await Events.emit('trigger');
+        await Events.emit('application-mounted');
+        await Events.emit('application-mounted');
+        await Events.emit('application-mounted');
 
         // Assert
         expect(counter).toEqual(3);
@@ -25,12 +25,12 @@ describe('Events', () => {
         // 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'));
+        Events.on('application-mounted', () => storage.push('second'));
+        Events.on('application-mounted', { priority: EventListenerPriorities.Low }, () => storage.push('third'));
+        Events.on('application-mounted', { priority: EventListenerPriorities.High }, () => storage.push('first'));
 
         // Act
-        await Events.emit('trigger');
+        await Events.emit('application-mounted');
 
         // Assert
         expect(storage).toEqual(['first', 'second', 'third']);

package/src/services/Events.ts

@@ -1,16 +1,15 @@
 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: number;
+    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;
@@ -26,18 +25,20 @@ export const EventListenerPriorities = {
     High: 256,
 } as const;
 
+export type EventListenerPriority = (typeof EventListenerPriorities)[keyof typeof EventListenerPriorities];
+
 export class EventsService extends Service {
 
     private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
 
-    protected async boot(): Promise<void> {
+    protected override async boot(): Promise<void> {
         Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
-            this.on(event as string, listener as EventListener));
+            // 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] ?? { priorities: [], handlers: {} };
 
@@ -48,19 +49,24 @@ export class EventsService extends Service {
 
     /* eslint-disable max-len */
     public on<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): () => void;
+    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
-    public on<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
-    public on<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
     /* eslint-enable max-len */
 
     public on(
         event: string,
-        optionsOrListener: Partial<EventListenerOptions> | EventListener,
+        optionsOrListener: Partial<EventListenerOptions> | EventListenerPriority | EventListener,
         listener?: EventListener,
     ): () => void {
-        const options = typeof optionsOrListener === 'function' ? {} : optionsOrListener;
+        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);
@@ -73,8 +79,6 @@ export class EventsService extends Service {
     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 extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
     /* eslint-enable max-len */
 
     public once(

package/src/services/Service.ts

@@ -1,49 +1,68 @@
-import { MagicObject, PromisedValue, Storage, 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 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 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[]) ?? [];
+        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(): UnrefServiceState<State> {
+        protected override 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 override getComputedStateDefinition(): ComputedStateDefinition<Unref<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<Unref<State>, ComputedState>;
         }
 
-        protected getComputedStateDefinition(): ComputedStateDefinition<UnrefServiceState<State>, ComputedState> {
-            return (options.computed ?? {}) as ComputedStateDefinition<UnrefServiceState<State>, ComputedState>;
+        protected override getStateWatchers(): StateWatchers<Service, Unref<State>> {
+            return (options.watch ?? {}) as StateWatchers<Service, Unref<State>>;
         }
 
-        protected serializePersistedState(state: Partial<State>): Partial<State> {
-            return options.serialize?.(state) ?? state;
+        protected override serializePersistedState(state: Partial<State>): ServiceStorage {
+            return options.serialize?.(state) ?? (state as ServiceStorage);
         }
 
-    } as unknown as Constructor<UnrefServiceState<State>> &
-        Constructor<ComputedState> &
-        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
+        protected override 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,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();
@@ -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 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));
 
@@ -149,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;
@@ -162,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>);
+    }
+
+    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);
 
-        Object.assign(this._store.$state, state);
+        if (isEmpty(state)) {
+            return;
+        }
 
-        this.onStateUpdated(state);
+        this.onPersistentStateUpdated(state);
     }
 
-    protected __get(property: string): unknown {
+    protected override __get(property: string): unknown {
         if (this.hasState(property)) {
             return this.getState(property);
         }
@@ -179,19 +227,29 @@ 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>);
+        }
+
+        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,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 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, {}> {
+        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;
+    }
+}