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

package/src/ui/index.ts

@@ -1,37 +1,52 @@
 import type { Component } from 'vue';
 
 import { bootServices } from '@/services';
-import { defineBootstrapHook } from '@/bootstrap/hooks';
+import { definePlugin } from '@/plugins';
 
 import UI, { UIComponents } from './UI';
 import AGAlertModal from '../components/modals/AGAlertModal.vue';
+import AGConfirmModal from '../components/modals/AGConfirmModal.vue';
+import AGErrorReportModal from '../components/modals/AGErrorReportModal.vue';
+import AGLoadingModal from '../components/modals/AGLoadingModal.vue';
+import AGPromptModal from '../components/modals/AGPromptModal.vue';
+import AGSnackbar from '../components/snackbars/AGSnackbar.vue';
+import AGStartupCrash from '../components/lib/AGStartupCrash.vue';
 import type { UIComponent } from './UI';
 
-export { UI, UIComponents, UIComponent };
-
 const services = { $ui: UI };
 
-export type UIServices = typeof services;
-
-export default defineBootstrapHook(async (app, options) => {
-    const defaultComponents = {
-        [UIComponents.AlertModal]: AGAlertModal,
-    };
+export * from './UI';
+export { default as UI } from './UI';
 
-    Object.entries({
-        ...defaultComponents,
-        ...options.components,
-    }).forEach(([name, component]) => UI.registerComponent(name as UIComponent, component));
+export type UIServices = typeof services;
 
-    await bootServices(app, services);
+export default definePlugin({
+    async install(app, options) {
+        const defaultComponents = {
+            [UIComponents.AlertModal]: AGAlertModal,
+            [UIComponents.ConfirmModal]: AGConfirmModal,
+            [UIComponents.ErrorReportModal]: AGErrorReportModal,
+            [UIComponents.LoadingModal]: AGLoadingModal,
+            [UIComponents.PromptModal]: AGPromptModal,
+            [UIComponents.Snackbar]: AGSnackbar,
+            [UIComponents.StartupCrash]: AGStartupCrash,
+        };
+
+        Object.entries({
+            ...defaultComponents,
+            ...options.components,
+        }).forEach(([name, component]) => UI.registerComponent(name as UIComponent, component));
+
+        await bootServices(app, services);
+    },
 });
 
 declare module '@/bootstrap/options' {
-    interface BootstrapOptions {
+    export interface AerogelOptions {
         components?: Partial<Record<UIComponent, Component>>;
     }
 }
 
 declare module '@/services' {
-    interface Services extends UIServices {}
+    export interface Services extends UIServices {}
 }

package/src/utils/composition/events.ts

@@ -14,6 +14,7 @@ export function useEvent<Event extends EventWithPayload>(
     event: Event,
     listener: EventListener<EventsPayload[Event]>
 ): void;
+export function useEvent<Payload>(event: string, listener: (payload: Payload) => unknown): void;
 export function useEvent<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): void;
 
 export function useEvent(event: string, listener: EventListener): void {

package/src/utils/composition/forms.ts

@@ -0,0 +1,11 @@
+import { objectWithout } from '@noeldemartin/utils';
+import { computed, useAttrs } from 'vue';
+import type { ComputedRef } from 'vue';
+
+export function useInputAttrs(): [ComputedRef<{}>, ComputedRef<unknown>] {
+    const attrs = useAttrs();
+    const className = computed(() => attrs.class);
+    const inputAttrs = computed(() => objectWithout(attrs, 'class'));
+
+    return [inputAttrs, className];
+}

package/src/utils/composition/hooks.ts

@@ -0,0 +1,9 @@
+import { noop } from '@noeldemartin/utils';
+import { onMounted, onUnmounted } from 'vue';
+
+export function onCleanMounted(operation: () => Function): void {
+    let cleanUp: Function = noop;
+
+    onMounted(() => (cleanUp = operation()));
+    onUnmounted(() => cleanUp());
+}

package/src/utils/index.ts

@@ -1 +1,5 @@
+export * from './composition/events';
+export * from './composition/forms';
+export * from './composition/hooks';
+export * from './tailwindcss';
 export * from './vue';

package/src/utils/markdown.ts

@@ -1,8 +1,17 @@
+import { tap } from '@noeldemartin/utils';
 import DOMPurify from 'dompurify';
-import { marked } from 'marked';
+import { Renderer, marked } from 'marked';
+
+function makeRenderer(): Renderer {
+    return tap(new Renderer(), (renderer) => {
+        renderer.link = function(href, title, text) {
+            return Renderer.prototype.link.apply(this, [href, title, text]).replace('<a', '<a target="_blank"');
+        };
+    });
+}
 
 export function renderMarkdown(markdown: string): string {
-    return safeHtml(marked(markdown, { mangle: false, headerIds: false }));
+    return safeHtml(marked(markdown, { mangle: false, headerIds: false, renderer: makeRenderer() }));
 }
 
 export function safeHtml(html: string): string {

package/src/utils/tailwindcss.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it } from 'vitest';
+
+import { removeInteractiveClasses } from './tailwindcss';
+
+describe('TailwindCSS utils', () => {
+
+    it('Removes interactive classes', () => {
+        const cases: [string, string][] = [
+            ['text-red hover:text-green', 'text-red'],
+            ['text-red hover:text-green text-lg', 'text-red text-lg'],
+            [
+                `
+                    text-red text-lg
+                    focus:text-yellow
+                    hover:focus:text-black
+                `,
+                'text-red text-lg',
+            ],
+        ];
+
+        cases.forEach(([original, expected]) => {
+            expect(removeInteractiveClasses(original)).toEqual(expected);
+        });
+    });
+
+});

package/src/utils/tailwindcss.ts

@@ -0,0 +1,7 @@
+export function removeInteractiveClasses(classes: string): string {
+    return classes
+        .split(/\s+/)
+        .filter((className) => !/^(hover|focus|focus-visible):/.test(className))
+        .join(' ')
+        .trim();
+}

package/src/utils/vue.ts

@@ -1,15 +1,17 @@
 import { fail } from '@noeldemartin/utils';
-import { inject, reactive, ref } from 'vue';
+import { computed, inject, reactive, ref, watch } from 'vue';
 import type { Directive, InjectionKey, PropType, Ref, UnwrapNestedRefs } from 'vue';
 
 type BaseProp<T> = {
-    type: PropType<T>;
+    type?: PropType<T>;
     validator?(value: unknown): boolean;
 };
 
 type RequiredProp<T> = BaseProp<T> & { required: true };
 type OptionalProp<T> = BaseProp<T> & { default: T | (() => T) | null };
 
+export type ComponentProps = Record<string, unknown>;
+
 export function arrayProp<T>(defaultValue?: () => T[]): OptionalProp<T[]> {
     return {
         type: Array as PropType<T[]>,
@@ -28,6 +30,15 @@ export function componentRef<T>(): Ref<UnwrapNestedRefs<T> | undefined> {
     return ref<UnwrapNestedRefs<T>>();
 }
 
+export function computedAsync<T>(getter: () => Promise<T>): Ref<T | undefined> {
+    const result = ref<T>();
+    const asyncValue = computed(getter);
+
+    watch(asyncValue, async () => (result.value = await asyncValue.value), { immediate: true });
+
+    return result;
+}
+
 export function defineDirective(directive: Directive): Directive {
     return directive;
 }
@@ -62,7 +73,7 @@ export function injectOrFail<T>(key: InjectionKey<T> | string, errorMessage?: st
     return inject(key) ?? fail(errorMessage ?? `Could not resolve '${key}' injection key`);
 }
 
-export function mixedProp<T>(type: PropType<T>): OptionalProp<T | null> {
+export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null> {
     return {
         type,
         default: null,
@@ -106,7 +117,7 @@ export function requiredEnumProp<Enum extends Record<string, unknown>>(
     };
 }
 
-export function requiredMixedProp<T>(type: PropType<T>): RequiredProp<T> {
+export function requiredMixedProp<T>(type?: PropType<T>): RequiredProp<T> {
     return {
         type,
         required: true,

package/tailwind.config.js

@@ -0,0 +1,4 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    content: ['./src/**/*.{vue,ts}'],
+};

package/tsconfig.json

@@ -1,15 +1,7 @@
 {
+    "extends": "../../tsconfig.json",
     "compilerOptions": {
-        "target": "esnext",
-        "module": "esnext",
-        "moduleResolution": "node",
-        "strict": true,
-        "types": [],
-        "jsx": "preserve",
-        "noUncheckedIndexedAccess": true,
-        "resolveJsonModule": true,
-        "esModuleInterop": true,
-        "lib": ["esnext", "dom"],
+        "types": ["unplugin-icons/types/vue3", "@aerogel/vite/dist/virtual"],
         "baseUrl": ".",
         "paths": {
             "@/*": ["./src/*"]

package/vite.config.ts

@@ -1,17 +1,14 @@
-import I18n from '@intlify/unplugin-vue-i18n/vite';
-import Vue from '@vitejs/plugin-vue';
+import Aerogel from '@aerogel/vite';
+import Icons from 'unplugin-icons/vite';
 import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
-const isTesting = process.env.NODE_ENV === 'test';
-
 export default defineConfig({
     test: { clearMocks: true },
-    plugins: [Vue(), I18n({ include: resolve(__dirname, './src/testing/stubs/lang/**/*.yaml') })],
+    plugins: [Aerogel(), Icons()],
     resolve: {
         alias: {
             '@': resolve(__dirname, './src'),
         },
     },
-    define: isTesting ? { __AG_BASE_PATH: 'undefined' } : undefined,
 });

package/.eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-    extends: ['@noeldemartin/eslint-config-vue'],
-};

package/src/bootstrap/hooks.ts

@@ -1,19 +0,0 @@
-import type { App } from 'vue';
-
-import type { BootstrapOptions } from '@/bootstrap/options';
-
-const mountedHooks: Function[] = [];
-
-export type BootstrapHook = (app: App, options: BootstrapOptions) => Promise<void>;
-
-export function onAppMounted(hook: Function): void {
-    mountedHooks.push(hook);
-}
-
-export function runAppMountedHooks(): void {
-    mountedHooks.forEach((hook) => hook());
-}
-
-export function defineBootstrapHook<T extends BootstrapHook>(hook: T): T {
-    return hook;
-}

package/src/components/basic/AGMarkdown.vue

@@ -1,20 +0,0 @@
-<template>
-    <root />
-</template>
-
-<script setup lang="ts">
-import { computed, h } from 'vue';
-
-import { renderMarkdown } from '@/utils/markdown';
-import { stringProp } from '@/utils/vue';
-import { lang } from '@/lang/helpers';
-
-const props = defineProps({
-    langKey: stringProp(),
-    text: stringProp(),
-});
-
-const markdown = computed(() => props.text ?? (props.langKey && lang(props.langKey)));
-const html = computed(() => markdown.value && renderMarkdown(markdown.value));
-const root = () => h('div', { class: 'prose', innerHTML: html.value });
-</script>

package/src/components/basic/index.ts

@@ -1,3 +0,0 @@
-import AGMarkdown from './AGMarkdown.vue';
-
-export { AGMarkdown };

package/src/lang/helpers.ts

@@ -1,5 +0,0 @@
-import Lang from '@/lang/Lang';
-
-export function lang(key: string, parameters: Record<string, unknown> = {}): string {
-    return Lang.translate(key, parameters);
-}

package/src/models/index.ts

@@ -1,18 +0,0 @@
-import { IndexedDBEngine, bootModelsFromViteGlob, setEngine } from 'soukai';
-
-import { defineBootstrapHook } from '@/bootstrap/hooks';
-
-export default defineBootstrapHook(async (_, options) => {
-    if (!options.models) {
-        return;
-    }
-
-    setEngine(new IndexedDBEngine());
-    bootModelsFromViteGlob(options.models);
-});
-
-declare module '@/bootstrap/options' {
-    interface BootstrapOptions {
-        models?: Record<string, Record<string, unknown>>;
-    }
-}

package/src/routing/index.ts

@@ -1,33 +0,0 @@
-import { createRouter, createWebHistory } from 'vue-router';
-import type { Plugin } from 'vue';
-
-import { defineBootstrapHook } from '@/bootstrap/hooks';
-
-function createAppRouter(options: { routes: RouteRecordRaw[]; basePath?: string }): Plugin {
-    return createRouter({
-        history: createWebHistory(options.basePath),
-        routes: options.routes,
-    });
-}
-
-export default defineBootstrapHook(async (app, options) => {
-    if (!options.routes) {
-        return;
-    }
-
-    const plugin = createAppRouter({
-        routes: options.routes,
-        basePath: options.basePath ?? __AG_BASE_PATH,
-    });
-
-    app.use(plugin);
-});
-
-declare module '@/bootstrap/options' {
-    interface BootstrapOptions {
-        routes?: RouteRecordRaw[];
-        basePath?: string;
-    }
-}
-
-import type { RouteRecordRaw } from 'vue-router';

package/src/testing/stubs/lang/en.yaml

@@ -1 +0,0 @@
-foo: Bar

package/src/testing/stubs/models/User.ts

@@ -1,3 +0,0 @@
-import { Model } from 'soukai';
-
-export default class User extends Model {}