@quaffui/quaff 1.0.0-beta6 → 1.0.0-beta9

package/dist/helpers/version.js

@@ -1 +1 @@
-export default "1.0.0-beta6";
+export default "1.0.0-beta9";

package/dist/utils/context.d.ts

@@ -1,33 +1,50 @@
-export declare const QBreadcrumbsCtxName: {
-    activeColor: symbol;
-    separator: symbol;
-};
-export declare const QDocsCtxName: {
-    snippets: symbol;
-};
-export declare const QItemCtxName: {
-    activeClass: symbol;
-    multiline: symbol;
-};
-export declare const QLayoutCtxName: {
-    view: symbol;
-    header: symbol;
-    footer: symbol;
-    railbar: {
-        left: symbol;
-        right: symbol;
-    };
-    drawer: {
-        left: symbol;
-        right: symbol;
-    };
-};
-export declare const QListCtxName: {
-    activeClass: symbol;
-    separator: symbol;
-};
-export declare const QTabsCtxName: {
-    request: symbol;
-    value: symbol;
-    variant: symbol;
+/**
+ * This function allows to manipulate contexts more easily.
+ * It avoids having to pass a Svelte store down the components but rather use runes to keep the context reactive.
+ */
+export declare function QContext<T>(name: string): {
+    /**
+     * The inner symbol used to identify the context.
+     */
+    readonly symbol: symbol;
+    /**
+     * Get the context value.
+     * @returns The context value or undefined if not found.
+     */
+    get(): T | undefined;
+    /**
+     * Get the context value or throw an error if not found.
+     *
+     * @param errorMsg Optional error message to throw if context is not found.
+     * @returns The context value.
+     * @throws Error if context is not found.
+     */
+    assertGet(errorMsg?: string): NonNullable<T>;
+    /**
+     * Set the context value.
+     * @param context The context value to set.
+     */
+    set(context: T): void;
+    /**
+     * Reset the context value.
+     */
+    reset(): void;
+    /**
+     * Checks whether the context exists.
+     * @returns True if the context exists, false otherwise.
+     */
+    exists(): boolean;
+    /**
+     * Update one entry of the context.
+     *
+     * @param key The key of the entry to update.
+     * @param value The new value for the entry.
+     */
+    updateEntry(key: keyof T, value: NonNullable<T>[keyof T]): void;
+    /**
+     * Update multiple entries of the context.
+     *
+     * @param updates The key/value pairs to update in the context.
+     */
+    updateEntries(updates: Partial<T>): void;
 };

package/dist/utils/context.js

@@ -1,33 +1,82 @@
-export const QBreadcrumbsCtxName = {
-    activeColor: Symbol("activeColor"),
-    separator: Symbol("separator"),
-};
-export const QDocsCtxName = {
-    snippets: Symbol("snippets"),
-};
-export const QItemCtxName = {
-    activeClass: Symbol("activeClass"),
-    multiline: Symbol("multiline"),
-};
-export const QLayoutCtxName = {
-    view: Symbol("layoutView"),
-    header: Symbol("QHeader"),
-    footer: Symbol("QFooter"),
-    railbar: {
-        left: Symbol("QRailbar-left"),
-        right: Symbol("QRailbar-right"),
-    },
-    drawer: {
-        left: Symbol("QDrawer-left"),
-        right: Symbol("QDrawer-right"),
-    },
-};
-export const QListCtxName = {
-    activeClass: Symbol("activeClass"),
-    separator: Symbol("separator"),
-};
-export const QTabsCtxName = {
-    request: Symbol("request"),
-    value: Symbol("value"),
-    variant: Symbol("variant"),
-};
+import { getContext, hasContext, setContext } from "svelte";
+/**
+ * This function allows to manipulate contexts more easily.
+ * It avoids having to pass a Svelte store down the components but rather use runes to keep the context reactive.
+ */
+export function QContext(name) {
+    const sym = Symbol(name);
+    return {
+        /**
+         * The inner symbol used to identify the context.
+         */
+        get symbol() {
+            return sym;
+        },
+        /**
+         * Get the context value.
+         * @returns The context value or undefined if not found.
+         */
+        get() {
+            return getContext(sym);
+        },
+        /**
+         * Get the context value or throw an error if not found.
+         *
+         * @param errorMsg Optional error message to throw if context is not found.
+         * @returns The context value.
+         * @throws Error if context is not found.
+         */
+        assertGet(errorMsg) {
+            const ctx = getContext(sym);
+            if (!ctx) {
+                throw new Error(errorMsg || `Context "${name}" not found`);
+            }
+            return ctx;
+        },
+        /**
+         * Set the context value.
+         * @param context The context value to set.
+         */
+        set(context) {
+            setContext(sym, context);
+        },
+        /**
+         * Reset the context value.
+         */
+        reset() {
+            setContext(sym, undefined);
+        },
+        /**
+         * Checks whether the context exists.
+         * @returns True if the context exists, false otherwise.
+         */
+        exists() {
+            return hasContext(sym);
+        },
+        /**
+         * Update one entry of the context.
+         *
+         * @param key The key of the entry to update.
+         * @param value The new value for the entry.
+         */
+        updateEntry(key, value) {
+            const ctx = getContext(sym);
+            if (!ctx) {
+                return;
+            }
+            ctx[key] = value;
+        },
+        /**
+         * Update multiple entries of the context.
+         *
+         * @param updates The key/value pairs to update in the context.
+         */
+        updateEntries(updates) {
+            const ctx = getContext(sym);
+            if (!ctx) {
+                return;
+            }
+            Object.assign(ctx, updates);
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quaffui/quaff",
-  "version": "1.0.0-beta6",
+  "version": "1.0.0-beta9",
   "scripts": {
     "dev": "vite dev",
     "open": "vite dev --open",
@@ -18,7 +18,8 @@
     "docgen-props": "bun scripts/docgenProps.ts",
     "colorgen": "bun scripts/colorgen.ts",
     "docgen-snippets": "bun scripts/docgenSnippets.ts",
-    "write-version": "bun scripts/writeVersion.ts"
+    "write-version": "bun scripts/writeVersion.ts",
+    "gen:plugins": "tsc --outDir plugins/dist plugins/index.ts --declaration --target esnext --module esnext --moduleResolution bundler"
   },
   "exports": {
     ".": {
@@ -36,36 +37,36 @@
     "shiki": "^3.4.2"
   },
   "devDependencies": {
-    "@fontsource/roboto": "^5.2.5",
-    "@sveltejs/adapter-static": "^3.0.8",
-    "@sveltejs/kit": "^2.21.1",
-    "@sveltejs/package": "^2.3.11",
-    "@sveltejs/vite-plugin-svelte": "^5.0.3",
+    "@fontsource/roboto": "^5.2.8",
+    "@sveltejs/adapter-static": "^3.0.9",
+    "@sveltejs/kit": "^2.42.2",
+    "@sveltejs/package": "^2.5.2",
+    "@sveltejs/vite-plugin-svelte": "^6.2.0",
     "@types/prettier": "^3.0.0",
     "@types/prismjs": "^1.26.5",
-    "@typescript-eslint/eslint-plugin": "^8.33.0",
-    "@typescript-eslint/parser": "^8.33.0",
-    "bun-types": "^1.2.15",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-import-x": "^4.15.0",
-    "eslint-plugin-svelte": "^3.9.0",
-    "eslint-plugin-unicorn": "^59.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.44.0",
+    "@typescript-eslint/parser": "^8.44.0",
+    "bun-types": "^1.2.22",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-svelte": "^3.12.3",
+    "eslint-plugin-unicorn": "^61.0.2",
     "estree-walker": "^3.0.3",
-    "globals": "^16.2.0",
-    "magic-string": "^0.30.17",
-    "material-symbols": "^0.31.4",
-    "prettier": "^3.5.3",
+    "globals": "^16.4.0",
+    "magic-string": "^0.30.19",
+    "material-symbols": "^0.35.2",
+    "prettier": "^3.6.2",
     "prettier-plugin-svelte": "^3.4.0",
-    "publint": "^0.3.12",
-    "sass": "^1.89.1",
-    "svelte": "^5.33.11",
-    "svelte-check": "^4.2.1",
-    "svelte-eslint-parser": "^1.2.0",
+    "publint": "^0.3.13",
+    "sass": "^1.92.1",
+    "svelte": "^5.39.2",
+    "svelte-check": "^4.3.1",
+    "svelte-eslint-parser": "^1.3.2",
     "tslib": "^2.8.1",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vitest": "^3.1.4"
+    "typescript": "^5.9.2",
+    "vite": "^7.1.6",
+    "vitest": "^3.2.4"
   },
   "svelte": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/classes/QContext.svelte.d.ts

@@ -1,42 +0,0 @@
-/**
- * This class allows to manipulate reactive contexts more easily.
- * It avoids having to pass a Svelte store down the components but rather use runes to keep the context reactive.
- *
- * This class should be used when the context has to be modified from a child component. Otherwise, using svelte's context API should be enough.
- */
-export declare class QContext<T> {
-    #private;
-    constructor(contextSymbol: symbol, init: T);
-    /**
-     * Gets the value of context with id `contextSymbol`
-     * @param contextSymbol - Name of the context to get
-     * @returns The context's value
-     */
-    static get<T>(contextSymbol: symbol): QContext<T> | undefined;
-    /**
-     * Prevents the propagation of the context further down
-     * @param contextSymbol - Name of the context to get
-     * @returns The context result
-     */
-    static reset(contextSymbol: symbol): void;
-    /**
-     * Updates the context's inner value with `newVal`
-     * @param newVal - New value to update the context with
-     */
-    update(newVal: T): void;
-    /**
-     * Updates the property of id `key` with `newVal` in the context's inner value
-     * @param key - Key to update
-     * @param newVal - New value to update the context's property with
-     */
-    updateEntry(key: keyof T, newVal: NonNullable<T>[keyof T]): void;
-    /**
-     * Updates the given properties their corresponding values in the context's inner value
-     * @param from - Object containing keys to update with their respective value
-     */
-    updateEntries(from: Record<keyof T, NonNullable<T>[keyof T]>): void;
-    /**
-     * Inner value of the context
-     */
-    get value(): T;
-}

package/dist/classes/QContext.svelte.js

@@ -1,63 +0,0 @@
-import { getContext, setContext } from "svelte";
-/**
- * This class allows to manipulate reactive contexts more easily.
- * It avoids having to pass a Svelte store down the components but rather use runes to keep the context reactive.
- *
- * This class should be used when the context has to be modified from a child component. Otherwise, using svelte's context API should be enough.
- */
-export class QContext {
-    #state = $state();
-    constructor(contextSymbol, init) {
-        this.#state = init;
-        setContext(contextSymbol, this);
-    }
-    /**
-     * Gets the value of context with id `contextSymbol`
-     * @param contextSymbol - Name of the context to get
-     * @returns The context's value
-     */
-    static get(contextSymbol) {
-        return getContext(contextSymbol);
-    }
-    /**
-     * Prevents the propagation of the context further down
-     * @param contextSymbol - Name of the context to get
-     * @returns The context result
-     */
-    static reset(contextSymbol) {
-        setContext(contextSymbol, undefined);
-    }
-    /**
-     * Updates the context's inner value with `newVal`
-     * @param newVal - New value to update the context with
-     */
-    update(newVal) {
-        this.#state = newVal;
-    }
-    /**
-     * Updates the property of id `key` with `newVal` in the context's inner value
-     * @param key - Key to update
-     * @param newVal - New value to update the context's property with
-     */
-    updateEntry(key, newVal) {
-        if (!this.#state || typeof this.#state !== "object" || !Object.hasOwn(this.#state, key)) {
-            throw new Error(`${key.toString()} doesn't exist on ${this.#state}`);
-        }
-        this.#state[key] = newVal;
-    }
-    /**
-     * Updates the given properties their corresponding values in the context's inner value
-     * @param from - Object containing keys to update with their respective value
-     */
-    updateEntries(from) {
-        for (const key in from) {
-            this.updateEntry(key, from[key]);
-        }
-    }
-    /**
-     * Inner value of the context
-     */
-    get value() {
-        return this.#state;
-    }
-}