@aerogel/core 0.0.0-next.d824b40e5d06757cd9f47c9f771d916185df4f05 → 0.0.0-next.f0368a3107664018eb88652e719d2cb7d24b82e7

package/src/lang/Lang.ts

@@ -1,10 +1,16 @@
-import { facade, toString } from '@noeldemartin/utils';
+import { facade } from '@noeldemartin/utils';
 
-import App from '@/services/App';
-import Service from '@/services/Service';
+import DefaultLangProvider from './DefaultLangProvider';
+import Service from './Lang.state';
 
 export interface LangProvider {
-    translate(key: string, parameters?: Record<string, unknown>): string;
+    getLocale(): string;
+    setLocale(locale: string): Promise<void>;
+    getFallbackLocale(): string;
+    setFallbackLocale(fallbackLocale: string): Promise<void>;
+    getLocales(): string[];
+    translate(key: string, parameters?: Record<string, unknown> | number): string;
+    translateWithDefault(key: string, defaultMessage: string, parameters?: Record<string, unknown> | number): string;
 }
 
 export class LangService extends Service {
@@ -14,47 +20,56 @@ export class LangService extends Service {
     constructor() {
         super();
 
-        this.provider = {
-            translate: (key) => {
-                // eslint-disable-next-line no-console
-                App.development && console.warn('Lang provider is missing');
-
-                return key;
-            },
-        };
+        this.provider = new DefaultLangProvider(
+            this.getState('locale') ?? this.getBrowserLocale(),
+            this.getState('fallbackLocale'),
+        );
     }
 
-    public setProvider(provider: LangProvider): void {
+    public async setProvider(provider: LangProvider): Promise<void> {
         this.provider = provider;
+        this.locales = provider.getLocales();
+
+        await provider.setLocale(this.locale ?? this.getBrowserLocale());
+        await provider.setFallbackLocale(this.fallbackLocale);
     }
 
-    public translate(key: string, parameters?: Record<string, unknown>): string {
+    public translate(key: string, parameters?: Record<string, unknown> | number): string {
         return this.provider.translate(key, parameters) ?? key;
     }
 
-    public translateWithDefault(key: string, defaultMessage: string): string;
-    public translateWithDefault(key: string, parameters: Record<string, unknown>, defaultMessage: string): string;
     public translateWithDefault(
         key: string,
-        defaultMessageOrParameters?: string | Record<string, unknown>,
-        defaultMessage?: string,
+        defaultMessage: string,
+        parameters: Record<string, unknown> | number = {},
     ): string {
-        defaultMessage ??= defaultMessageOrParameters as string;
+        return this.provider.translateWithDefault(key, defaultMessage, parameters);
+    }
 
-        const parameters = typeof defaultMessageOrParameters === 'string' ? {} : defaultMessageOrParameters ?? {};
-        const message = this.provider.translate(key, parameters) ?? key;
+    public getBrowserLocale(): string {
+        const locales = this.getState('locales');
 
-        if (message === key) {
-            return Object.entries(parameters).reduce(
-                (renderedMessage, [name, value]) =>
-                    renderedMessage.replace(new RegExp(`\\{\\s*${name}\\s*\\}`, 'g'), toString(value)),
-                defaultMessage,
-            );
+        return navigator.languages.find((locale) => locales.includes(locale)) ?? 'en';
+    }
+
+    protected override async boot(): Promise<void> {
+        if (!globalThis.document) {
+            return;
         }
 
-        return message;
+        this.requireStore().$subscribe(
+            async () => {
+                await this.provider.setLocale(this.locale ?? this.getBrowserLocale());
+                await this.provider.setFallbackLocale(this.fallbackLocale);
+
+                this.locale
+                    ? document.querySelector('html')?.setAttribute('lang', this.locale)
+                    : document.querySelector('html')?.removeAttribute('lang');
+            },
+            { immediate: true },
+        );
     }
 
 }
 
-export default facade(new LangService());
+export default facade(LangService);

package/src/lang/index.ts

@@ -1,10 +1,14 @@
-import { bootServices } from '@/services';
-import { definePlugin } from '@/plugins';
+import App from '@aerogel/core/services/App';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
 
-import Lang, { LangProvider } from './Lang';
+import Lang from './Lang';
+import settings from './settings';
+import type { LangProvider } from './Lang';
 import { translate, translateWithDefault } from './utils';
 
-export { Lang, LangProvider, translate, translateWithDefault };
+export { Lang, translate, translateWithDefault };
+export type { LangProvider };
 
 const services = { $lang: Lang };
 
@@ -15,15 +19,17 @@ export default definePlugin({
         app.config.globalProperties.$t ??= translate;
         app.config.globalProperties.$td = translateWithDefault;
 
+        settings.forEach((setting) => App.addSetting(setting));
+
         await bootServices(app, services);
     },
 });
 
-declare module '@/services' {
+declare module '@aerogel/core/services' {
     export interface Services extends LangServices {}
 }
 
-declare module '@vue/runtime-core' {
+declare module 'vue' {
     interface ComponentCustomProperties {
         $td: typeof translateWithDefault;
     }

package/src/lang/settings/Language.vue

@@ -0,0 +1,48 @@
+<template>
+    <Select
+        v-model="$lang.locale"
+        class="flex flex-col items-start md:flex-row"
+        as="div"
+        :options
+        :render-option="renderLocale"
+    >
+        <div class="grow">
+            <SelectLabel>
+                {{ $td('settings.locale', 'Language') }}
+            </SelectLabel>
+            <Markdown
+                lang-key="settings.localeDescription"
+                lang-default="Choose the application's language."
+                class="mt-1 text-sm text-gray-500"
+            />
+        </div>
+        <Button variant="ghost" :as="SelectTrigger" class="grid w-auto outline-none" />
+        <SelectOptions />
+    </Select>
+</template>
+
+<script setup lang="ts">
+import Aerogel from 'virtual:aerogel';
+
+import { computed } from 'vue';
+
+import Markdown from '@aerogel/core/components/ui/Markdown.vue';
+import Button from '@aerogel/core/components/ui/Button.vue';
+import Select from '@aerogel/core/components/ui/Select.vue';
+import SelectLabel from '@aerogel/core/components/ui/SelectLabel.vue';
+import SelectTrigger from '@aerogel/core/components/ui/SelectTrigger.vue';
+import SelectOptions from '@aerogel/core/components/ui/SelectOptions.vue';
+import { Lang, translateWithDefault } from '@aerogel/core/lang';
+
+const browserLocale = Lang.getBrowserLocale();
+const options = computed(() => [null, ...Lang.locales]);
+
+function renderLocale(locale: string | null): string {
+    return (
+        (locale && Aerogel.locales[locale]) ??
+        translateWithDefault('settings.localeDefault', '{locale} (default)', {
+            locale: Aerogel.locales[browserLocale] ?? browserLocale,
+        })
+    );
+}
+</script>

package/src/lang/settings/index.ts

@@ -0,0 +1,10 @@
+import { defineSettings } from '@aerogel/core/services';
+
+import Language from './Language.vue';
+
+export default defineSettings([
+    {
+        priority: 100,
+        component: Language,
+    },
+]);

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,18 +1,50 @@
-import Build from 'virtual:aerogel';
+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: Build.environment,
-        sourceUrl: Build.sourceUrl,
-        isMounted: false,
+        instance: null as App | null,
+        environment: getEnv() ?? 'development',
+        version: Aerogel.version,
+        sourceUrl: Aerogel.sourceUrl,
+        settings: [] as AppSetting[],
     },
     computed: {
         development: (state) => state.environment === 'development',
-        testing: (state) => state.environment === 'testing',
+        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,20 +1,63 @@
-import { facade } from '@noeldemartin/utils';
+import Aerogel from 'virtual:aerogel';
 
-import Events from '@/services/Events';
-import type { Plugin } from '@/plugins';
+import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
+import { markRaw } from 'vue';
+
+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>();
+
+    public isReady(): boolean {
+        return this.ready.isResolved();
+    }
+
+    public isMounted(): boolean {
+        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);
+
+        return result;
+    }
+
+    public async reload(queryParameters?: Record<string, string | undefined>): Promise<void> {
+        queryParameters && updateLocationQueryParameters(queryParameters);
+
+        location.reload();
+
+        // Stall until the reload happens
+        await forever();
+    }
+
     public plugin<T extends Plugin = Plugin>(name: string): T | null {
         return (this.plugins[name] as T) ?? null;
     }
 
-    protected async boot(): Promise<void> {
-        Events.once('application-mounted', () => this.setState({ isMounted: true }));
+    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());
     }
 
 }
 
-export default facade(new AppService());
+export default facade(AppService);

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

@@ -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('application-mounted', () => counter++);
+
+        // Act
+        await Events.emit('application-mounted');
+        await Events.emit('application-mounted');
+        await Events.emit('application-mounted');
+
+        // Assert
+        expect(counter).toEqual(3);
+    });
+
+    it('triggers listeners by priority', async () => {
+        // Arrange
+        const storage: string[] = [];
+
+        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('application-mounted');
+
+        // Assert
+        expect(storage).toEqual(['first', 'second', 'third']);
+    });
+
+});

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;
+}