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

package/src/utils/composition/state.test.ts

@@ -0,0 +1,47 @@
+import { after } from '@noeldemartin/utils';
+import { describe, expect, it } from 'vitest';
+import { ref } from 'vue';
+
+import { computedDebounce } from './state';
+
+describe('Vue state helpers', () => {
+
+    it('computes debounced state', async () => {
+        // Initial
+        const state = ref(0);
+        const value = computedDebounce({ delay: 90 }, () => state.value);
+
+        expect(value.value).toBe(null);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(0);
+
+        // Update
+        state.value = 42;
+
+        expect(value.value).toBe(0);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(42);
+
+        // Debounced Update
+        state.value = 23;
+
+        expect(value.value).toBe(42);
+
+        await after({ ms: 50 });
+
+        state.value = 32;
+
+        await after({ ms: 50 });
+
+        expect(value.value).toBe(42);
+
+        await after({ ms: 100 });
+
+        expect(value.value).toBe(32);
+    });
+
+});

package/src/utils/composition/state.ts

@@ -0,0 +1,24 @@
+import { debounce } from '@noeldemartin/utils';
+import { ref, watchEffect } from 'vue';
+import type { ComputedGetter, ComputedRef } from '@vue/runtime-core';
+
+export interface ComputedDebounceOptions<T> {
+    initial?: T;
+    delay?: number;
+}
+
+export function computedDebounce<T>(options: ComputedDebounceOptions<T>, getter: ComputedGetter<T>): ComputedRef<T>;
+export function computedDebounce<T>(getter: ComputedGetter<T>): ComputedRef<T | null>;
+export function computedDebounce<T>(
+    optionsOrGetter: ComputedGetter<T> | ComputedDebounceOptions<T>,
+    inputGetter?: ComputedGetter<T>,
+): ComputedRef<T> {
+    const inputOptions = inputGetter ? (optionsOrGetter as ComputedDebounceOptions<T>) : {};
+    const getter = inputGetter ?? (optionsOrGetter as ComputedGetter<T>);
+    const state = ref(inputOptions.initial ?? null);
+    const update = debounce((value) => (state.value = value), inputOptions.delay ?? 300);
+
+    watchEffect(() => update(getter()));
+
+    return state as unknown as ComputedRef<T>;
+}

package/src/utils/index.ts

@@ -1,4 +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,9 +1,9 @@
 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;
 };
 
@@ -30,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;
 }
@@ -64,13 +73,22 @@ 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 listenerProp<T extends Function = Function>(): OptionalProp<T | null> {
     return {
-        type,
+        type: Function as PropType<T>,
         default: null,
     };
 }
 
+export function mixedProp<T>(type?: PropType<T>): OptionalProp<T | null>;
+export function mixedProp<T>(type: PropType<T>, defaultValue: T): OptionalProp<T>;
+export function mixedProp<T>(type?: PropType<T>, defaultValue?: T): OptionalProp<T | null> {
+    return {
+        type,
+        default: defaultValue ?? null,
+    };
+}
+
 export function numberProp(): OptionalProp<number | null>;
 export function numberProp(defaultValue: number): OptionalProp<number>;
 export function numberProp(defaultValue: number | null = null): OptionalProp<number | null> {
@@ -108,7 +126,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,7 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "compilerOptions": {
-        "types": ["unplugin-icons/types/vue3"],
+        "types": ["unplugin-icons/types/vue3", "@aerogel/vite/dist/virtual"],
         "baseUrl": ".",
         "paths": {
             "@/*": ["./src/*"]

package/vite.config.ts

@@ -4,7 +4,10 @@ import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
-    test: { clearMocks: true },
+    test: {
+        clearMocks: true,
+        setupFiles: ['./src/testing/setup.ts'],
+    },
     plugins: [Aerogel(), Icons()],
     resolve: {
         alias: {

package/.eslintrc.js

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

package/dist/virtual.d.ts

@@ -1,11 +0,0 @@
-declare module 'virtual:aerogel' {
-    interface AerogelBuild {
-        environment: 'production' | 'development' | 'testing';
-        basePath?: string;
-        sourceUrl?: string;
-    }
-
-    const build: AerogelBuild;
-
-    export default build;
-}

package/src/components/basic/index.ts

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

package/src/types/virtual.d.ts

@@ -1,11 +0,0 @@
-declare module 'virtual:aerogel' {
-    interface AerogelBuild {
-        environment: 'production' | 'development' | 'testing';
-        basePath?: string;
-        sourceUrl?: string;
-    }
-
-    const build: AerogelBuild;
-
-    export default build;
-}