@agnos-ui/svelte-headless 0.8.1 → 0.9.0

package/config.d.ts

@@ -1,17 +1,7 @@
-import type { Partial2Levels, WidgetsConfigStore } from '@agnos-ui/core/config';
+import type { WidgetsConfig, Partial2Levels, WidgetsConfigStore } from '@agnos-ui/core/config';
 import type { ReadableSignal } from '@amadeus-it-group/tansu';
-import type { Widget, WidgetProps, WidgetFactory } from './types';
+import type { Widget, WidgetFactory, WidgetProps } from '@agnos-ui/core/types';
 export * from '@agnos-ui/core/config';
-type WidgetFactoryInput<Config extends {
-    [widgetName: string]: object;
-}, W extends Widget> = {
-    factory: WidgetFactory<W>;
-    widgetName?: null | keyof Config;
-    defaultConfig?: Partial<WidgetProps<W>> | ReadableSignal<Partial<WidgetProps<W>> | undefined>;
-    events?: Partial<Pick<WidgetProps<W>, keyof WidgetProps<W> & `on${string}Change`>>;
-    props?: Partial<WidgetProps<W>>;
-    enablePatchChanged?: true;
-};
 type AdaptParentConfig<Config> = (config: Partial2Levels<Config>) => Partial2Levels<Config>;
 type CreateWidgetsDefaultConfig<Config extends {
     [widgetName: string]: object;
@@ -34,6 +24,14 @@ export declare const widgetsConfigFactory: <Config extends {
     widgetsDefaultConfigKey: symbol;
     createWidgetsDefaultConfig: CreateWidgetsDefaultConfig<Config>;
     getContextWidgetConfig: <N extends keyof Config>(widgetName: N) => ReadableSignal<Partial<Config[N]> | undefined>;
-    callWidgetFactory: <W extends Widget>(input: WidgetFactoryInput<Config, W>) => WidgetSlotContext<W_1>;
+    callWidgetFactory: <W extends Widget>(factory: WidgetFactory<W>, options?: {
+        defaultConfig?: Partial<WidgetProps<W>> | ReadableSignal<Partial<WidgetProps<W>> | undefined>;
+        events?: Partial<Pick<WidgetProps<W>, keyof WidgetProps<W> & `on${string}Change`>>;
+        props?: Partial<WidgetProps<W>>;
+    }) => WidgetSlotContext<W_1>;
 };
-export declare const widgetsDefaultConfigKey: symbol, createWidgetsDefaultConfig: CreateWidgetsDefaultConfig<WidgetsConfig>, getContextWidgetConfig: <N extends string | number | symbol>(widgetName: N) => ReadableSignal<any>, callWidgetFactory: <W extends Widget>(input: WidgetFactoryInput<WidgetsConfig, W>) => WidgetSlotContext<W_1>;
+export declare const widgetsDefaultConfigKey: symbol, createWidgetsDefaultConfig: CreateWidgetsDefaultConfig<WidgetsConfig>, getContextWidgetConfig: <N extends string | number | symbol>(widgetName: N) => ReadableSignal<any>, callWidgetFactory: <W extends Widget>(factory: WidgetFactory<W>, options?: {
+    defaultConfig?: Partial<WidgetProps<W>> | ReadableSignal<Partial<WidgetProps<W>> | undefined>;
+    events?: Partial<Pick<WidgetProps<W>, keyof WidgetProps<W> & `on${string}Change`>>;
+    props?: Partial<WidgetProps<W>>;
+} | undefined) => WidgetSlotContext<W_1>;

package/config.js

@@ -1,4 +1,5 @@
 import { createWidgetsConfig } from '@agnos-ui/core/config';
+import { FACTORY_WIDGET_NAME } from '@agnos-ui/core/types';
 import { computed } from '@amadeus-it-group/tansu';
 import { getContext, setContext } from 'svelte';
 import { callWidgetFactoryWithConfig } from './utils/widget.svelte';
@@ -57,19 +58,33 @@ export const widgetsConfigFactory = (widgetsDefaultConfigKey = Symbol('widgetsCo
         setContext(widgetsDefaultConfigKey, child$);
         return child$;
     };
+    /**
+     * Retrieves a widgets configuration store from the Svelte context hierarchy.
+     *
+     * @param widgetName - the name of the widget
+     * @returns the widgets configuration store
+     */
     const getContextWidgetConfig = (widgetName) => {
         const widgetsConfig = getContext(widgetsDefaultConfigKey);
         return computed(() => widgetsConfig?.()[widgetName]);
     };
-    const callWidgetFactory = (input) => callWidgetFactoryWithConfig({
-        factory: input.factory,
-        defaultConfig: input.defaultConfig,
-        widgetConfig: input.widgetName ? getContextWidgetConfig(input.widgetName) : null,
-        events: input.events,
+    /**
+     * Creates and initializes a widget using the provided factory and configuration options.
+     *
+     * @param factory - the widget factory
+     * @param options  - the optional options
+     * @param options.defaultConfig - the default configuration for the widget
+     * @param options.events - the events to be passed to the widget
+     * @param options.props - the props to be passed to the widget
+     * @returns the state, api and directives to track and interact with the widget
+     */
+    const callWidgetFactory = (factory, options) => callWidgetFactoryWithConfig(factory, {
+        defaultConfig: options?.defaultConfig,
+        widgetConfig: factory[FACTORY_WIDGET_NAME] ? getContextWidgetConfig(factory[FACTORY_WIDGET_NAME]) : null,
+        events: options?.events,
         get props() {
-            return input.props;
+            return options?.props;
         },
-        enablePatchChanged: input.enablePatchChanged,
     });
     return {
         /**

package/generated/index.d.ts

@@ -13,6 +13,7 @@ export * from './services/transitions/cssTransitions';
 export * from './services/transitions/collapse';
 export * from './services/transitions/baseTransitions';
 export * from './utils/writables';
+export * from './utils/widget';
 export * from './utils/stores';
 export * from './utils/func';
 export * from './utils/directive';

package/generated/index.js

@@ -13,6 +13,7 @@ export * from './services/transitions/cssTransitions';
 export * from './services/transitions/collapse';
 export * from './services/transitions/baseTransitions';
 export * from './utils/writables';
+export * from './utils/widget';
 export * from './utils/stores';
 export * from './utils/func';
 export * from './utils/directive';

package/generated/utils/widget.d.ts

@@ -0,0 +1 @@
+export * from '@agnos-ui/core/utils/widget';

package/generated/utils/widget.js

@@ -0,0 +1 @@
+export * from '@agnos-ui/core/utils/widget';

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@agnos-ui/svelte-headless",
 	"description": "Headless component library for Svelte.",
-	"version": "0.8.1",
+	"version": "0.9.0",
 	"type": "module",
 	"main": "./index.js",
 	"module": "./index.js",
@@ -49,7 +49,7 @@
 		}
 	},
 	"dependencies": {
-		"@agnos-ui/core": "0.8.1"
+		"@agnos-ui/core": "0.9.0"
 	},
 	"peerDependencies": {
 		"@amadeus-it-group/tansu": "^2.0.0",

package/utils/widget.svelte.d.ts

@@ -3,20 +3,17 @@ import type { Widget, WidgetFactory, WidgetProps, WidgetSlotContext } from '../t
 /**
  * Call a widget factory using provided configs.
  *
- * @param parameter - the parameter
- * @param parameter.factory - the widget factory to call
- * @param parameter.defaultConfig - the default config of the widget
- * @param parameter.widgetConfig - the config of the widget, overriding the defaultConfig
- * @param parameter.events - the events of the widget
- * @param parameter.props - the props of the widget
- * @param parameter.enablePatchChanged - enable patching changed props
- * @returns the widget
+ * @param factory - the widget factory to call
+ * @param options - the optional options
+ * @param options.defaultConfig - the default config of the widget
+ * @param options.widgetConfig - the config of the widget, overriding the defaultConfig
+ * @param options.events - the events of the widget
+ * @param options.props - the props of the widget
+ * @returns the state, api and directives to track and interact with the widget
  */
-export declare const callWidgetFactoryWithConfig: <W extends Widget>(parameter: {
-    factory: WidgetFactory<W>;
+export declare const callWidgetFactoryWithConfig: <W extends Widget>(factory: WidgetFactory<W>, options?: {
     defaultConfig?: Partial<WidgetProps<W>> | ReadableSignal<Partial<WidgetProps<W>> | undefined>;
     widgetConfig?: null | undefined | ReadableSignal<Partial<WidgetProps<W>> | undefined>;
     events?: Partial<Pick<WidgetProps<W>, keyof WidgetProps<W> & `on${string}Change`>>;
     props?: Partial<WidgetProps<W>>;
-    enablePatchChanged?: true;
 }) => WidgetSlotContext<W>;

package/utils/widget.svelte.js

@@ -39,18 +39,17 @@ const eventStore = (event, prop) => {
 /**
  * Call a widget factory using provided configs.
  *
- * @param parameter - the parameter
- * @param parameter.factory - the widget factory to call
- * @param parameter.defaultConfig - the default config of the widget
- * @param parameter.widgetConfig - the config of the widget, overriding the defaultConfig
- * @param parameter.events - the events of the widget
- * @param parameter.props - the props of the widget
- * @param parameter.enablePatchChanged - enable patching changed props
- * @returns the widget
+ * @param factory - the widget factory to call
+ * @param options - the optional options
+ * @param options.defaultConfig - the default config of the widget
+ * @param options.widgetConfig - the config of the widget, overriding the defaultConfig
+ * @param options.events - the events of the widget
+ * @param options.props - the props of the widget
+ * @returns the state, api and directives to track and interact with the widget
  */
-export const callWidgetFactoryWithConfig = (parameter) => {
-    const { factory, defaultConfig, widgetConfig, events, enablePatchChanged } = parameter;
-    const props = parameter.props ?? {};
+export const callWidgetFactoryWithConfig = (factory, options) => {
+    const { defaultConfig, widgetConfig, events } = options ?? {};
+    const props = options?.props ?? {};
     const defaultConfig$ = toReadableStore(defaultConfig);
     const propsWithEvents = { ...props };
     if (events) {
@@ -63,12 +62,10 @@ export const callWidgetFactoryWithConfig = (parameter) => {
         props: propsWithEvents,
     });
     const runes = Object.fromEntries(Object.entries(widget.stores).map(([key, val]) => [key.slice(0, -1), fromStore(val)]));
-    if (enablePatchChanged) {
-        const patch = createPatchChangedProps(props, widget.patch);
-        $effect(() => {
-            patch({ ...parameter.props });
-        });
-    }
+    const patch = createPatchChangedProps(props, widget.patch);
+    $effect(() => {
+        patch({ ...options?.props });
+    });
     return {
         api: widget.api,
         directives: widget.directives,