@aerogel/core 0.0.0-next.f86b4b09f066c4aef21796a37dbc8417b7dce3cd → 0.0.0-next.f8c757d83e1e0d001a2836fa45aba318ec17b9b9

package/src/directives/index.ts

@@ -1,13 +1,11 @@
 import type { Directive } from 'vue';
 
-import { definePlugin } from '@/plugins';
+import { definePlugin } from '@aerogel/core/plugins';
 
-import initialFocus from './initial-focus';
 import measure from './measure';
 
 const builtInDirectives: Record<string, Directive> = {
-    'initial-focus': initialFocus,
-    'measure': measure,
+    measure: measure,
 };
 
 export * from './measure';
@@ -25,8 +23,14 @@ export default definePlugin({
     },
 });
 
-declare module '@/bootstrap/options' {
+declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
         directives?: Record<string, Directive>;
     }
 }
+
+declare module 'vue' {
+    interface ComponentCustomDirectives {
+        measure: Directive<string, string>;
+    }
+}

package/src/directives/measure.ts

@@ -1,4 +1,4 @@
-import { defineDirective } from '@/utils/vue';
+import { defineDirective } from '@aerogel/core/utils/vue';
 import { tap } from '@noeldemartin/utils';
 
 const resizeObservers: WeakMap<HTMLElement, ResizeObserver> = new WeakMap();

package/src/errors/Errors.state.ts

@@ -1,6 +1,6 @@
 import type { JSError } from '@noeldemartin/utils';
 
-import { defineServiceState } from '@/services';
+import { defineServiceState } from '@aerogel/core/services';
 
 export type ErrorSource = string | Error | JSError | unknown;
 

package/src/errors/Errors.ts

@@ -1,16 +1,15 @@
-import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noeldemartin/utils';
+import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty, toString } from '@noeldemartin/utils';
 
-import App from '@/services/App';
-import ServiceBootError from '@/errors/ServiceBootError';
-import UI, { UIComponents } from '@/ui/UI';
-import { translateWithDefault } from '@/lang/utils';
+import App from '@aerogel/core/services/App';
+import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
+import UI, { UIComponents } from '@aerogel/core/ui/UI';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
+import { Events } from '@aerogel/core/services';
+import type { ErrorReportModalProps } from '@aerogel/core/components/contracts/ErrorReportModal';
+import type { ModalComponent } from '@aerogel/core/ui/UI.state';
 
 import Service from './Errors.state';
-import { Colors } from '@/components/constants';
-import { Events } from '@/services';
-import type { AGErrorReportModalProps } from '@/components/modals/AGErrorReportModal';
 import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
-import type { ModalComponent } from '@/ui/UI.state';
 
 export class ErrorsService extends Service {
 
@@ -34,7 +33,7 @@ export class ErrorsService extends Service {
             return;
         }
 
-        UI.openModal<ModalComponent<AGErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
+        UI.openModal<ModalComponent<ErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
             reports,
         });
     }
@@ -42,11 +41,11 @@ export class ErrorsService extends Service {
     public async report(error: ErrorSource, message?: string): Promise<void> {
         await Events.emit('error', { error, message });
 
-        if (App.testing) {
+        if (isTesting('unit')) {
             throw error;
         }
 
-        if (App.development) {
+        if (isDevelopment()) {
             this.logError(error);
         }
 
@@ -71,17 +70,17 @@ export class ErrorsService extends Service {
             date: new Date(),
         };
 
-        UI.showSnackbar(
+        UI.toast(
             message ??
                 translateWithDefault('errors.notice', 'Something went wrong, but it\'s not your fault. Try again!'),
             {
-                color: Colors.Danger,
+                variant: 'danger',
                 actions: [
                     {
-                        text: translateWithDefault('errors.viewDetails', 'View details'),
+                        label: translateWithDefault('errors.viewDetails', 'View details'),
                         dismiss: true,
-                        handler: () =>
-                            UI.openModal<ModalComponent<AGErrorReportModalProps>>(
+                        click: () =>
+                            UI.openModal<ModalComponent<ErrorReportModalProps>>(
                                 UI.requireComponent(UIComponents.ErrorReportModal),
                                 { reports: [report] },
                             ),
@@ -178,7 +177,7 @@ export class ErrorsService extends Service {
 
 export default facade(ErrorsService);
 
-declare module '@/services/Events' {
+declare module '@aerogel/core/services/Events' {
     export interface EventsPayload {
         error: { error: ErrorSource; message?: string };
     }

package/src/errors/JobCancelledError.ts

@@ -0,0 +1,3 @@
+import { JSError } from '@noeldemartin/utils';
+
+export default class JobCancelledError extends JSError {}

package/src/errors/index.ts

@@ -1,13 +1,16 @@
 import type { App } from 'vue';
 
-import { bootServices } from '@/services';
-import { definePlugin } from '@/plugins';
+import { bootServices } from '@aerogel/core/services';
+import { definePlugin } from '@aerogel/core/plugins';
 
 import Errors from './Errors';
-import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
+import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
 
 export * from './utils';
-export { Errors, ErrorSource, ErrorReport, ErrorReportLog };
+export { Errors };
+export { default as JobCancelledError } from './JobCancelledError';
+export { default as ServiceBootError } from './ServiceBootError';
+export type { ErrorSource, ErrorReport, ErrorReportLog };
 
 const services = { $errors: Errors };
 const frameworkHandler: ErrorHandler = (error) => {
@@ -35,12 +38,12 @@ export default definePlugin({
     },
 });
 
-declare module '@/bootstrap/options' {
+declare module '@aerogel/core/bootstrap/options' {
     export interface AerogelOptions {
         handleError?(error: ErrorSource): boolean;
     }
 }
 
-declare module '@/services' {
+declare module '@aerogel/core/services' {
     export interface Services extends ErrorsServices {}
 }

package/src/errors/utils.ts

@@ -1,5 +1,5 @@
 import { JSError, isObject, toString } from '@noeldemartin/utils';
-import { translateWithDefault } from '@/lang/utils';
+import { translateWithDefault } from '@aerogel/core/lang/utils';
 import type { ErrorSource } from './Errors.state';
 
 const handlers: ErrorHandler[] = [];

package/src/forms/{Form.test.ts → FormController.test.ts}

@@ -1,10 +1,11 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
 
-import { useForm } from './composition';
-import { FormFieldTypes } from '@/main';
-import { numberInput, requiredStringInput } from '@/forms/utils';
+import { useForm } from '@aerogel/core/forms/composition';
+import { numberInput, requiredStringInput } from '@aerogel/core/forms/utils';
 
-describe('Form', () => {
+import { FormFieldTypes } from './FormController';
+
+describe('FormController', () => {
 
     it('defines magic fields', () => {
         const form = useForm({

package/src/forms/{Form.ts → FormController.ts}

@@ -38,21 +38,21 @@ export type FormErrors<T> = {
 export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.String
     ? string
     : TType extends typeof FormFieldTypes.Number
-    ? number
-    : TType extends typeof FormFieldTypes.Boolean
-    ? boolean
-    : TType extends typeof FormFieldTypes.Object
-    ? object
-    : TType extends typeof FormFieldTypes.Date
-    ? Date
-    : never;
+      ? number
+      : TType extends typeof FormFieldTypes.Boolean
+        ? boolean
+        : TType extends typeof FormFieldTypes.Object
+          ? object
+          : TType extends typeof FormFieldTypes.Date
+            ? Date
+            : never;
 
-const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
+const validForms: WeakMap<FormController, ComputedRef<boolean>> = new WeakMap();
 
 export type SubmitFormListener = () => unknown;
 export type FocusFormListener = (input: string) => unknown;
 
-export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
+export default class FormController<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
 
     public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
 
@@ -113,11 +113,14 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
     }
 
     public validate(): boolean {
-        const errors = Object.entries(this._fields).reduce((formErrors, [name, definition]) => {
-            formErrors[name] = this.getFieldErrors(name, definition);
+        const errors = Object.entries(this._fields).reduce(
+            (formErrors, [name, definition]) => {
+                formErrors[name] = this.getFieldErrors(name, definition);
 
-            return formErrors;
-        }, {} as Record<string, string[] | null>);
+                return formErrors;
+            },
+            {} as Record<string, string[] | null>,
+        );
 
         this.resetErrors(errors);
 
@@ -165,7 +168,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         this._listeners['focus']?.forEach((listener) => listener(input));
     }
 
-    protected __get(property: string): unknown {
+    protected override __get(property: string): unknown {
         if (!(property in this._fields)) {
             return super.__get(property);
         }
@@ -173,7 +176,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
         return this.getFieldValue(property);
     }
 
-    protected __set(property: string, value: unknown): void {
+    protected override __set(property: string, value: unknown): void {
         if (!(property in this._fields)) {
             super.__set(property, value);
 
@@ -204,10 +207,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
             return {} as FormData<Fields>;
         }
 
-        const data = Object.entries(fields).reduce((formData, [name, definition]) => {
-            formData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
+        const data = Object.entries(fields).reduce((initialData, [name, definition]) => {
+            initialData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
 
-            return formData;
+            return initialData;
         }, {} as FormData<Fields>);
 
         return reactive(data) as FormData<Fields>;

package/src/forms/composition.ts

@@ -1,6 +1,6 @@
-import Form from '@/forms/Form';
-import type { FormData, FormFieldDefinitions } from '@/forms/Form';
+import FormController from '@aerogel/core/forms/FormController';
+import type { FormData, FormFieldDefinitions } from '@aerogel/core/forms/FormController';
 
-export function useForm<const T extends FormFieldDefinitions>(fields: T): Form<T> & FormData<T> {
-    return new Form(fields) as Form<T> & FormData<T>;
+export function useForm<const T extends FormFieldDefinitions>(fields: T): FormController<T> & FormData<T> {
+    return new FormController(fields) as FormController<T> & FormData<T>;
 }

package/src/forms/index.ts

@@ -1,5 +1,5 @@
 export * from './composition';
-export * from './Form';
+export * from './FormController';
 export * from './utils';
 export * from './validation';
-export { default as Form } from './Form';
+export { default as FormController } from './FormController';

package/src/forms/utils.ts

@@ -1,5 +1,5 @@
-import { FormFieldTypes } from './Form';
-import type { FormFieldDefinition } from './Form';
+import { FormFieldTypes } from './FormController';
+import type { FormFieldDefinition } from './FormController';
 
 export function booleanInput(
     defaultValue?: boolean,

package/src/index.css

@@ -0,0 +1,46 @@
+@import 'tailwindcss';
+
+@source './';
+@source '../../plugin-local-first/src';
+@source '../../plugin-solid/src';
+
+@plugin '@tailwindcss/forms';
+@plugin '@tailwindcss/typography';
+
+@theme {
+    --color-background: oklch(1 0 0);
+    --color-primary: oklch(0.205 0 0);
+    --color-danger: oklch(0.577 0.245 27.325);
+    --color-accent: oklch(0.97 0 0);
+}
+
+.clickable {
+    position: relative;
+}
+
+.clickable::after {
+    --clickable-size: 44px;
+    --clickable-inset-by: min(0px, calc((100% - var(--clickable-size)) / 2));
+
+    content: '';
+    position: absolute;
+    top: var(--clickable-inset-by);
+    left: var(--clickable-inset-by);
+    right: var(--clickable-inset-by);
+    bottom: var(--clickable-inset-by);
+}
+
+input[type='number'].appearance-textfield {
+    appearance: textfield;
+}
+
+input[type='number'].appearance-textfield::-webkit-outer-spin-button,
+input[type='number'].appearance-textfield::-webkit-inner-spin-button {
+    appearance: none;
+}
+
+button[data-markdown-action] {
+    color: var(--tw-prose-links);
+    text-decoration: underline;
+    font-weight: 500;
+}

package/src/jobs/Job.ts

@@ -1,5 +1,147 @@
-export default abstract class Job {
+import { ListenersManager, PromisedValue, round, tap, toError } from '@noeldemartin/utils';
+import type { Listeners } from '@noeldemartin/utils';
 
-    public abstract run(): Promise<void>;
+import JobCancelledError from '@aerogel/core/errors/JobCancelledError';
+
+import type { JobListener } from './listeners';
+import type { JobStatus } from './status';
+
+export default abstract class Job<
+    Listener extends JobListener = JobListener,
+    Status extends JobStatus = JobStatus,
+    SerializedStatus extends JobStatus = JobStatus,
+> {
+
+    protected status: Status;
+    protected _listeners: ListenersManager<JobListener>;
+    protected _progress?: number;
+    protected _cancelled?: PromisedValue<void>;
+    protected _started: PromisedValue<void>;
+    protected _completed: PromisedValue<void>;
+
+    constructor() {
+        this.status = this.getInitialStatus();
+        this._listeners = new ListenersManager();
+        this._started = new PromisedValue();
+        this._completed = new PromisedValue();
+    }
+
+    public async start(): Promise<void> {
+        this.beforeStart();
+        this._started.resolve();
+
+        try {
+            await this.updateProgress();
+            await this.run();
+            await this.updateProgress();
+
+            this._completed.resolve();
+        } catch (error) {
+            if (error instanceof JobCancelledError) {
+                return;
+            }
+
+            throw tap(toError(error), (realError) => {
+                this._completed.reject(realError);
+            });
+        }
+    }
+
+    public async cancel(): Promise<void> {
+        this._cancelled = new PromisedValue();
+
+        await this._cancelled;
+    }
+
+    public serialize(): SerializedStatus {
+        return this.serializeStatus(this.status);
+    }
+
+    public get listeners(): Listeners<Listener> {
+        return this._listeners;
+    }
+
+    public get progress(): number {
+        return this._progress ?? 0;
+    }
+
+    public get cancelled(): boolean {
+        return !!this._cancelled?.isResolved();
+    }
+
+    public get started(): Promise<void> {
+        return this._started;
+    }
+
+    public get completed(): Promise<void> {
+        return this._completed;
+    }
+
+    protected abstract run(): Promise<void>;
+
+    protected getInitialStatus(): Status {
+        return { completed: false } as Status;
+    }
+
+    protected beforeStart(): void {
+        if (!this._started.isResolved()) {
+            return;
+        }
+
+        if (this._cancelled) {
+            delete this._progress;
+            delete this._cancelled;
+
+            return;
+        }
+
+        throw new Error('Job already started!');
+    }
+
+    protected assertNotCancelled(): void {
+        if (!this._cancelled) {
+            return;
+        }
+
+        this._cancelled.resolve();
+
+        throw new JobCancelledError();
+    }
+
+    protected calculateCurrentProgress(status?: JobStatus): number {
+        status ??= this.status;
+
+        if (status.completed) {
+            return 1;
+        }
+
+        if (!status.children) {
+            return 0;
+        }
+
+        return round(
+            status.children.reduce((total, child) => total + this.calculateCurrentProgress(child), 0) /
+                status.children.length,
+            2,
+        );
+    }
+
+    protected async updateProgress(update?: (status: Status) => unknown): Promise<void> {
+        await update?.(this.status);
+
+        const progress = this.calculateCurrentProgress();
+
+        if (progress === this._progress) {
+            return;
+        }
+
+        this._progress = progress;
+
+        await this._listeners.emit('onUpdated', progress);
+    }
+
+    protected serializeStatus(status: Status): SerializedStatus {
+        return { ...status } as unknown as SerializedStatus;
+    }
 
 }

package/src/jobs/index.ts

@@ -1,7 +1,10 @@
 import Job from './Job';
 
 export { Job };
+export * from './Job';
+export * from './listeners';
+export * from './status';
 
 export async function dispatch(job: Job): Promise<void> {
-    await job.run();
+    await job.start();
 }

package/src/jobs/listeners.ts

@@ -0,0 +1,3 @@
+export interface JobListener {
+    onUpdated?(progress: number): unknown;
+}

package/src/jobs/status.ts

@@ -0,0 +1,4 @@
+export interface JobStatus {
+    completed: boolean;
+    children?: JobStatus[];
+}

package/src/lang/DefaultLangProvider.ts

@@ -1,10 +1,13 @@
-import App from '@/services/App';
+import { isDevelopment } from '@noeldemartin/utils';
 
 import type { LangProvider } from './Lang';
 
 export default class DefaultLangProvider implements LangProvider {
 
-    constructor(private locale: string, private fallbackLocale: string) {}
+    constructor(
+        private locale: string,
+        private fallbackLocale: string,
+    ) {}
 
     public getLocale(): string {
         return this.locale;
@@ -28,14 +31,14 @@ export default class DefaultLangProvider implements LangProvider {
 
     public translate(key: string): string {
         // eslint-disable-next-line no-console
-        App.development && console.warn('Lang provider is missing');
+        isDevelopment() && console.warn('Lang provider is missing');
 
         return key;
     }
 
     public translateWithDefault(_: string, defaultMessage: string): string {
         // eslint-disable-next-line no-console
-        App.development && console.warn('Lang provider is missing');
+        isDevelopment() && console.warn('Lang provider is missing');
 
         return defaultMessage;
     }

package/src/lang/Lang.state.ts

@@ -1,4 +1,4 @@
-import { defineServiceState } from '@/services/Service';
+import { defineServiceState } from '@aerogel/core/services/Service';
 
 export default defineServiceState({
     name: 'lang',

package/src/lang/Lang.ts

@@ -52,7 +52,7 @@ export class LangService extends Service {
         return navigator.languages.find((locale) => locales.includes(locale)) ?? 'en';
     }
 
-    protected async boot(): Promise<void> {
+    protected override async boot(): Promise<void> {
         if (!globalThis.document) {
             return;
         }

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 };
 
@@ -14,16 +18,17 @@ export default definePlugin({
     async install(app) {
         app.config.globalProperties.$t ??= translate;
         app.config.globalProperties.$td = translateWithDefault;
+        App.settings.push(...settings);
 
         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="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>