@aerogel/core 0.0.0-next.7f6ed5a1f91688a86bf5ede2adc465e4fd6cfdea → 0.0.0-next.824cf5311c4335d119158f507dad094ed4f4f0b6

package/src/services/Service.ts

@@ -1,50 +1,126 @@
-import { MagicObject, PromisedValue } from '@noeldemartin/utils';
-import { reactive } 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: UnrefServiceState<TState>) => TComputedState[K];
+} & ThisType<{
+    readonly [K in keyof TComputedState]: TComputedState[K];
+}>;
+
+export function defineServiceState<
+    State extends ServiceState = ServiceState,
+    ComputedState extends ServiceState = {}
+>(options: {
+    name: string;
+    initialState: State | (() => State);
+    persist?: (keyof 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> {
+
+        public static persist = (options.persist as string[]) ?? [];
+
+        protected usesStore(): boolean {
+            return true;
+        }
+
+        protected getName(): string | null {
+            return options.name ?? null;
+        }
 
-export function defineServiceState<State extends ServiceState>(options: {
-    initialState: State;
-}): Constructor<State> & ServiceConstructor {
-    return class extends Service<State> {
+        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<UnrefServiceState<State>, ComputedState> {
+            return (options.computed ?? {}) as ComputedStateDefinition<UnrefServiceState<State>, ComputedState>;
+        }
 
-        protected getInitialState(): State {
-            return options.initialState;
+        protected serializePersistedState(state: Partial<State>): Partial<State> {
+            return options.serialize?.(state) ?? state;
         }
-    
-    } as unknown as Constructor<State> & ServiceConstructor;
+
+    } as unknown as Constructor<UnrefServiceState<State>> &
+        Constructor<ComputedState> &
+        Constructor<Service<UnrefServiceState<State>, ComputedState, Partial<UnrefServiceState<State>>>>;
 }
 
-export default class Service<State extends ServiceState = DefaultServiceState> extends MagicObject {
+export default class Service<
+    State extends ServiceState = DefaultServiceState,
+    ComputedState extends ServiceState = {},
+    ServiceStorage extends Partial<State> = 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 _store: Store | 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._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) {
@@ -54,38 +130,124 @@ export default class Service<State extends ServiceState = DefaultServiceState> e
         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 super.__get(property);
+        if (this.hasState(property)) {
+            return this.getState(property);
         }
 
-        return this.getState(property);
+        return super.__get(property);
     }
 
     protected __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 onStateUpdated(state: Partial<State>): void {
+        // TODO fix this.static()
+        const persist = (this.constructor as unknown as { persist: string[] }).persist;
+        const persisted = objectOnly(state, persist);
+
+        if (isEmpty(persisted)) {
+            return;
+        }
+
+        const storage = Storage.get<ServiceStorage>(this._name);
+
+        if (!storage) {
+            return;
+        }
+
+        Storage.set(this._name, {
+            ...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 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

@@ -1,15 +1,21 @@
-import type { App } from 'vue';
+import type { App as VueApp } from 'vue';
 
+import { definePlugin } from '@/plugins';
+
+import App from './App';
 import Events from './Events';
 import Service from './Service';
-import { defineBootstrapHook } from '@/bootstrap/hooks';
+import { getPiniaStore } from './store';
 
+export * from './App';
 export * from './Events';
 export * from './Service';
+export * from './store';
 
-export { Events, Service };
+export { App, Events, Service };
 
 const defaultServices = {
+    $app: App,
     $events: Events,
 };
 
@@ -17,18 +23,38 @@ 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: 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 defineBootstrapHook((app) => bootServices(app, defaultServices));
+export default definePlugin({
+    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/types/vite.d.ts

@@ -1,3 +1 @@
 /// <reference types="vite/client" />
-
-declare const __AG_BASE_PATH: string | undefined;

package/src/ui/UI.state.ts

@@ -2,10 +2,6 @@ import type { Component } from 'vue';
 
 import { defineServiceState } from '@/services/Service';
 
-export interface State {
-    modals: Modal[];
-}
-
 export interface Modal<T = unknown> {
     id: string;
     properties: Record<string, unknown>;
@@ -21,6 +17,16 @@ export interface ModalComponent<
     Result = unknown
 > {}
 
-export default defineServiceState<State>({
-    initialState: { modals: [] },
+export interface Snackbar {
+    id: string;
+    component: Component;
+    properties: Record<string, unknown>;
+}
+
+export default defineServiceState({
+    name: 'ui',
+    initialState: {
+        modals: [] as Modal[],
+        snackbars: [] as Snackbar[],
+    },
 });

package/src/ui/UI.ts

@@ -1,12 +1,14 @@
-import { facade, fail, uuid } from '@noeldemartin/utils';
+import { after, facade, fail, uuid } from '@noeldemartin/utils';
 import { markRaw, nextTick } from 'vue';
 import type { Component } from 'vue';
 import type { ObjectValues } from '@noeldemartin/utils';
 
 import Events from '@/services/Events';
+import type { SnackbarAction, SnackbarColor } from '@/components/headless/snackbars';
+import type { AGAlertModalProps, AGConfirmModalProps, AGLoadingModalProps, AGPromptModalProps } from '@/components';
 
 import Service from './UI.state';
-import type { Modal, ModalComponent } from './UI.state';
+import type { Modal, ModalComponent, Snackbar } from './UI.state';
 
 interface ModalCallbacks<T = unknown> {
     willClose(result: T | undefined): void;
@@ -20,17 +22,164 @@ type ModalResult<TComponent> = TComponent extends ModalComponent<Record<string,
 
 export const UIComponents = {
     AlertModal: 'alert-modal',
+    ConfirmModal: 'confirm-modal',
+    ErrorReportModal: 'error-report-modal',
+    LoadingModal: 'loading-modal',
+    PromptModal: 'prompt-modal',
+    Snackbar: 'snackbar',
+    StartupCrash: 'startup-crash',
 } as const;
 
 export type UIComponent = ObjectValues<typeof UIComponents>;
 
+export interface ConfirmOptions {
+    acceptText?: string;
+    cancelText?: string;
+}
+
+export interface PromptOptions {
+    label?: string;
+    defaultValue?: string;
+    placeholder?: string;
+    acceptText?: string;
+    cancelText?: string;
+}
+
+export interface ShowSnackbarOptions {
+    component?: Component;
+    color?: SnackbarColor;
+    actions?: SnackbarAction[];
+}
+
 export class UIService extends Service {
 
     private modalCallbacks: Record<string, Partial<ModalCallbacks>> = {};
     private components: Partial<Record<UIComponent, Component>> = {};
 
-    public alert(message: string): void {
-        this.openModal(this.requireComponent(UIComponents.AlertModal), { message });
+    public requireComponent(name: UIComponent): Component {
+        return this.components[name] ?? fail(`UI Component '${name}' is not defined!`);
+    }
+
+    public alert(message: string): void;
+    public alert(title: string, message: string): void;
+    public alert(messageOrTitle: string, message?: string): void {
+        const getProperties = (): AGAlertModalProps => {
+            if (typeof message !== 'string') {
+                return { message: messageOrTitle };
+            }
+
+            return {
+                title: messageOrTitle,
+                message,
+            };
+        };
+
+        this.openModal(this.requireComponent(UIComponents.AlertModal), getProperties());
+    }
+
+    public async confirm(message: string, options?: ConfirmOptions): Promise<boolean>;
+    public async confirm(title: string, message: string, options?: ConfirmOptions): Promise<boolean>;
+    public async confirm(
+        messageOrTitle: string,
+        messageOrOptions?: string | ConfirmOptions,
+        options?: ConfirmOptions,
+    ): Promise<boolean> {
+        const getProperties = (): AGConfirmModalProps => {
+            if (typeof messageOrOptions !== 'string') {
+                return {
+                    message: messageOrTitle,
+                    ...(messageOrOptions ?? {}),
+                };
+            }
+
+            return {
+                title: messageOrTitle,
+                message: messageOrOptions,
+                ...(options ?? {}),
+            };
+        };
+
+        const modal = await this.openModal<ModalComponent<AGConfirmModalProps, boolean>>(
+            this.requireComponent(UIComponents.ConfirmModal),
+            getProperties(),
+        );
+        const result = await modal.beforeClose;
+
+        return result ?? false;
+    }
+
+    public async prompt(message: string, options?: PromptOptions): Promise<string | null>;
+    public async prompt(title: string, message: string, options?: PromptOptions): Promise<string | null>;
+    public async prompt(
+        messageOrTitle: string,
+        messageOrOptions?: string | PromptOptions,
+        options?: PromptOptions,
+    ): Promise<string | null> {
+        const getProperties = (): AGPromptModalProps => {
+            if (typeof messageOrOptions !== 'string') {
+                return {
+                    message: messageOrTitle,
+                    ...(messageOrOptions ?? {}),
+                };
+            }
+
+            return {
+                title: messageOrTitle,
+                message: messageOrOptions,
+                ...(options ?? {}),
+            };
+        };
+
+        const modal = await this.openModal<ModalComponent<AGPromptModalProps, string | null>>(
+            this.requireComponent(UIComponents.PromptModal),
+            getProperties(),
+        );
+        const result = await modal.beforeClose;
+
+        return result ?? null;
+    }
+
+    public async loading<T>(operation: Promise<T>): Promise<T>;
+    public async loading<T>(message: string, operation: Promise<T>): Promise<T>;
+    public async loading<T>(messageOrOperation: string | Promise<T>, operation?: Promise<T>): Promise<T> {
+        const getProperties = (): AGLoadingModalProps => {
+            if (typeof messageOrOperation !== 'string') {
+                return {};
+            }
+
+            return { message: messageOrOperation };
+        };
+
+        const modal = await this.openModal(this.requireComponent(UIComponents.LoadingModal), getProperties());
+
+        try {
+            operation = typeof messageOrOperation === 'string' ? (operation as Promise<T>) : messageOrOperation;
+
+            const [result] = await Promise.all([operation, after({ seconds: 1 })]);
+
+            return result;
+        } finally {
+            await this.closeModal(modal.id);
+        }
+    }
+
+    public showSnackbar(message: string, options: ShowSnackbarOptions = {}): void {
+        const snackbar: Snackbar = {
+            id: uuid(),
+            properties: { message, ...options },
+            component: options.component ?? markRaw(this.requireComponent(UIComponents.Snackbar)),
+        };
+
+        this.setState('snackbars', this.snackbars.concat(snackbar));
+
+        setTimeout(() => this.hideSnackbar(snackbar.id), 5000);
+    }
+
+    public hideSnackbar(id: string): void {
+        this.setState(
+            'snackbars',
+            this.snackbars.filter((snackbar) => snackbar.id !== id),
+        );
     }
 
     public registerComponent(name: UIComponent, component: Component): void {
@@ -72,13 +221,8 @@ export class UIService extends Service {
     }
 
     protected async boot(): Promise<void> {
-        await super.boot();
-
         this.watchModalEvents();
-    }
-
-    private requireComponent(name: UIComponent): Component {
-        return this.components[name] ?? fail(`UI Component '${name}' is not defined!`);
+        this.watchMountedEvent();
     }
 
     private watchModalEvents(): void {
@@ -91,7 +235,10 @@ export class UIService extends Service {
         });
 
         Events.on('modal-closed', async ({ modal, result }) => {
-            this.setState({ modals: this.modals.filter((m) => m.id !== modal.id) });
+            this.setState(
+                'modals',
+                this.modals.filter((m) => m.id !== modal.id),
+            );
 
             this.modalCallbacks[modal.id]?.closed?.(result);
 
@@ -103,9 +250,27 @@ export class UIService extends Service {
         });
     }
 
+    private watchMountedEvent(): void {
+        Events.once('application-mounted', async () => {
+            const splash = document.getElementById('splash');
+
+            if (!splash) {
+                return;
+            }
+
+            if (window.getComputedStyle(splash).opacity !== '0') {
+                splash.style.opacity = '0';
+
+                await after({ ms: 600 });
+            }
+
+            splash.remove();
+        });
+    }
+
 }
 
-export default facade(new UIService());
+export default facade(UIService);
 
 declare module '@/services/Events' {
     export interface EventsPayload {