@aerogel/core 0.0.0-next.c8f032a868370824898e171969aec1bb6827688e → 0.0.0-next.d34923f3b144e8f6720e6a9cdadb2cd4fb4ab289

package/src/services/Service.ts

@@ -1,75 +1,126 @@
-import { computed, reactive } from 'vue';
-import { MagicObject, PromisedValue } from '@noeldemartin/utils';
-import type { ComputedRef } from 'vue';
+import { MagicObject, PromisedValue, Storage, 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';
+import { defineServiceStore } from '@/services/store';
 
 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 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];
+}>;
 
 export function defineServiceState<
     State extends ServiceState = ServiceState,
     ComputedState extends ServiceState = {}
 >(options: {
-    initialState: State;
+    name: string;
+    initialState: State | (() => State);
+    persist?: (keyof State)[];
     computed?: ComputedStateDefinition<State, ComputedState>;
-}): Constructor<State> & Constructor<ComputedState> & ServiceConstructor {
-    return class extends Service<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> {
+
+        public static persist = (options.persist as string[]) ?? [];
+
+        protected usesStore(): boolean {
+            return true;
+        }
+
+        protected getName(): string | null {
+            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>;
         }
-    
-    } as unknown as Constructor<State> & Constructor<ComputedState> & ServiceConstructor;
+
+        protected serializePersistedState(state: Partial<State>): Partial<State> {
+            return options.serialize?.(state) ?? state;
+        }
+
+    } as unknown as Constructor<UnrefServiceState<State>> &
+        Constructor<ComputedState> &
+        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
 }
 
 export default class Service<
     State extends ServiceState = DefaultServiceState,
-    ComputedState extends ServiceState = {}
+    ComputedState extends ServiceState = {},
+    ServiceStorage extends Partial<State> = Partial<State>
 > extends MagicObject {
 
-    protected _namespace: string;
+    public static persist: string[] = [];
+
+    protected _name: string;
     private _booted: PromisedValue<void>;
-    private _state: State;
-    private _computedState: Record<keyof ComputedState, ComputedRef>;
+    private _computedStateKeys: Set<keyof State>;
+    private _store: Store | false;
 
     constructor() {
         super();
 
-        this._namespace = new.target.name;
-        this._booted = new PromisedValue();
-        this._state = reactive(this.getInitialState());
-        this._computedState = Object.entries(this.getComputedStateDefinition()).reduce(
-            (computedState, [name, method]) => {
-                computedState[name as keyof ComputedState] = computed(() => method(this._state));
+        const getters = this.getComputedStateDefinition();
 
-                return computedState;
-            },
-            {} as Record<keyof ComputedState, ComputedRef>,
-        );
+        this._name = this.getName() ?? new.target.name;
+        this._booted = new PromisedValue();
+        this._computedStateKeys = new Set(Object.keys(getters));
+        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));
-
-        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) {
@@ -79,15 +130,52 @@ 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;
+        }
+
+        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;
+        }
+
+        return store ? store : {};
+    }
+
+    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 state = (
+            typeof stateOrProperty === 'string' ? { [stateOrProperty]: value } : stateOrProperty
+        ) as Partial<State>;
+
+        Object.assign(this._store.$state, state);
+
+        this.onStateUpdated(state);
+    }
+
     protected __get(property: string): unknown {
         if (this.hasState(property)) {
             return this.getState(property);
         }
 
-        if (this.hasComputedState(property)) {
-            return this.getComputedState(property);
-        }
-
         return super.__get(property);
     }
 
@@ -95,26 +183,33 @@ export default class Service<
         this.setState({ [property]: value } as Partial<State>);
     }
 
-    protected hasState<P extends keyof State>(property: P): boolean {
-        return property in this._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 hasComputedState<P extends keyof State>(property: P): boolean {
-        return property in this._computedState;
-    }
+        if (isEmpty(persisted)) {
+            return;
+        }
+
+        const storage = Storage.get<ServiceStorage>(this._name);
+
+        if (!storage) {
+            return;
+        }
 
-    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;
+        Storage.set(this._name, {
+            ...storage,
+            ...this.serializePersistedState(objectDeepClone(persisted) as Partial<State>),
+        });
     }
 
-    protected getComputedState<P extends keyof ComputedState>(property: P): ComputedState[P] {
-        return this._computedState[property]?.value;
+    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 {
@@ -125,8 +220,34 @@ export default class Service<
         return {} as ComputedStateDefinition<State, ComputedState>;
     }
 
+    protected serializePersistedState(state: Partial<State>): Partial<State> {
+        return state;
+    }
+
+    protected async frameworkBoot(): Promise<void> {
+        this.initializePersistedState();
+    }
+
     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)) {
+            return;
+        }
+
+        if (Storage.has(this._name)) {
+            const persisted = Storage.require<ServiceStorage>(this._name);
+            this.setState(persisted);
+
+            return;
+        }
+
+        Storage.set(this._name, objectOnly(this.getState(), persist));
     }
 
 }

package/src/services/index.ts

@@ -3,14 +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,
@@ -24,20 +28,36 @@ export interface Services extends DefaultServices {}
 export async function bootServices(app: VueApp, 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);
+
+    App.development && Object.assign(window, services);
 }
 
 export default definePlugin({
-    async install(app) {
-        await bootServices(app, defaultServices);
+    async install(app, options) {
+        const services = {
+            ...defaultServices,
+            ...options.services,
+        };
+
+        app.use(getPiniaStore());
+
+        await bootServices(app, services);
     },
 });
 
+declare module '@/bootstrap/options' {
+    export interface AerogelOptions {
+        services?: Record<string, Service>;
+    }
+}
+
 declare module '@vue/runtime-core' {
     interface ComponentCustomProperties extends Services {}
 }

package/src/services/store.ts

@@ -0,0 +1,30 @@
+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 {
+    return _store ?? resetPiniaStore();
+}
+
+export function resetPiniaStore(): Pinia {
+    return tap(createPinia(), (store) => {
+        _store = store;
+
+        setActivePinia(store);
+    });
+}
+
+export function getPiniaStore(): Pinia {
+    return _store ?? initializePiniaStore();
+}
+
+export function defineServiceStore<Id extends string, S extends StateTree = {}, G extends _GettersTree<S> = {}, A = {}>(
+    name: Id,
+    options: Omit<DefineStoreOptions<Id, S, G, A>, 'id'>,
+): Store<Id, S, G, A> {
+    initializePiniaStore();
+
+    return defineStore(name, options)();
+}

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/ui/UI.state.ts

@@ -17,6 +17,16 @@ export interface ModalComponent<
     Result = unknown
 > {}
 
+export interface Snackbar {
+    id: string;
+    component: Component;
+    properties: Record<string, unknown>;
+}
+
 export default defineServiceState({
-    initialState: { modals: [] as Modal[] },
+    name: 'ui',
+    initialState: {
+        modals: [] as Modal[],
+        snackbars: [] as Snackbar[],
+    },
 });