@agnos-ui/svelte-headless 0.0.1-alpha.5 → 0.0.1-alpha.7

package/components/accordion/index.d.ts

@@ -0,0 +1 @@
+export * from './accordion';

package/components/accordion/index.js

@@ -0,0 +1 @@
+export * from './accordion';

package/components/alert/index.d.ts

@@ -0,0 +1 @@
+export * from './alert';

package/components/alert/index.js

@@ -0,0 +1 @@
+export * from './alert';

package/components/modal/index.d.ts

@@ -0,0 +1 @@
+export * from './modal';

package/components/modal/index.js

@@ -0,0 +1 @@
+export * from './modal';

package/components/pagination/index.d.ts

@@ -0,0 +1 @@
+export * from './pagination';

package/components/pagination/index.js

@@ -0,0 +1 @@
+export * from './pagination';

package/components/progressbar/index.d.ts

@@ -0,0 +1 @@
+export * from './progressbar';

package/components/progressbar/index.js

@@ -0,0 +1 @@
+export * from './progressbar';

package/components/rating/index.d.ts

@@ -0,0 +1 @@
+export * from './rating';

package/components/rating/index.js

@@ -0,0 +1 @@
+export * from './rating';

package/components/select/index.d.ts

@@ -0,0 +1 @@
+export * from './select';

package/components/select/index.js

@@ -0,0 +1 @@
+export * from './select';

package/components/slider/index.d.ts

@@ -0,0 +1 @@
+export * from './slider';

package/components/slider/index.js

@@ -0,0 +1 @@
+export * from './slider';

package/config.d.ts

@@ -19,6 +19,14 @@ type AdaptParentConfig<Config> = (config: Partial2Levels<Config>) => Partial2Lev
 type CreateWidgetsDefaultConfig<Config extends {
     [widgetName: string]: object;
 }> = (adaptParentConfig?: AdaptParentConfig<Config>) => WidgetsConfigStore<Config>;
+/**
+ * A factory to create the utilities to allow widgets to be context-aware.
+ *
+ * It can be used when extending the core and creating new widgets.
+ *
+ * @param widgetsDefaultConfigKey - the widgets config key
+ * @returns the utilities to create / manage widgets and contexts
+ */
 export declare const widgetsConfigFactory: <Config extends {
     [widgetName: string]: object;
 } = WidgetsConfig>(widgetsDefaultConfigKey?: symbol) => {

package/config.js

@@ -3,6 +3,14 @@ import { computed } from '@amadeus-it-group/tansu';
 import { getContext, setContext } from 'svelte';
 import { callWidgetFactoryWithConfig } from './utils/widget';
 export * from '@agnos-ui/core/config';
+/**
+ * A factory to create the utilities to allow widgets to be context-aware.
+ *
+ * It can be used when extending the core and creating new widgets.
+ *
+ * @param widgetsDefaultConfigKey - the widgets config key
+ * @returns the utilities to create / manage widgets and contexts
+ */
 export const widgetsConfigFactory = (widgetsDefaultConfigKey = Symbol('widgetsConfig')) => {
     /**
      * Creates in the Svelte context hierarchy a new widgets default configuration store that inherits from any widgets default configuration

package/generated/index.d.ts

@@ -10,11 +10,11 @@ export * from './services/transitions/cssTransitions';
 export * from './services/transitions/collapse';
 export * from './services/transitions/bootstrap';
 export * from './services/transitions/baseTransitions';
-export * from './types';
-export * from './config';
 export * from './utils/writables';
 export * from './utils/stores';
 export * from './utils/directive';
+export * from './types';
+export * from './config';
 export * from './utils/widget';
 export * from './slot';
 export * from './Slot.svelte.d';

package/generated/index.js

@@ -10,11 +10,11 @@ export * from './services/transitions/cssTransitions';
 export * from './services/transitions/collapse';
 export * from './services/transitions/bootstrap';
 export * from './services/transitions/baseTransitions';
-export * from './types';
-export * from './config';
 export * from './utils/writables';
 export * from './utils/stores';
 export * from './utils/directive';
+export * from './types';
+export * from './config';
 export * from './utils/widget';
 export * from './slot';
 export * from './Slot.svelte.d';

package/package.json

@@ -48,14 +48,14 @@
 		}
 	},
 	"dependencies": {
-		"@agnos-ui/core": "0.0.1-alpha.5",
-		"@amadeus-it-group/tansu": "0.0.24"
+		"@agnos-ui/core": "0.0.1-alpha.7",
+		"@amadeus-it-group/tansu": "1.0.0"
 	},
 	"peerDependencies": {
 		"svelte": "*"
 	},
 	"sideEffects": false,
-	"version": "0.0.1-alpha.5",
+	"version": "0.0.1-alpha.7",
 	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",
 	"bugs": "https://github.com/AmadeusITGroup/AgnosUI/issues",
 	"license": "MIT",

package/utils/widget.d.ts

@@ -1,5 +1,17 @@
 import type { ReadableSignal } from '@amadeus-it-group/tansu';
 import type { SlotContent, SlotSvelteComponent, SlotsPresent, WidgetFactory, WidgetProps } from '../types';
+/**
+ * Call a widget factory using provided configs.
+ *
+ * @param parameter - the parameter
+ * @param parameter.factory - the widget factory to call
+ * @param parameter.$$slots - the slots of the widget
+ * @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
+ * @returns the widget
+ */
 export declare const callWidgetFactoryWithConfig: <W extends Widget>({ factory, $$slots, defaultConfig, widgetConfig, events, $$props, }: {
     factory: WidgetFactory<W>;
     $$slots: SlotsPresent<WidgetProps<W>>;
@@ -10,4 +22,10 @@ export declare const callWidgetFactoryWithConfig: <W extends Widget>({ factory,
 }) => W & {
     patchChangedProps: W["patch"];
 };
+/**
+ * A type guard checking if a provided slot content is a Svelte component.
+ *
+ * @param content - the slot content
+ * @returns true if the slot content is a svelte component
+ */
 export declare const isSvelteComponent: <Props extends object>(content: any) => content is SlotSvelteComponent<Props>;

package/utils/widget.js

@@ -24,7 +24,9 @@ const mergeEventFns = (fn1, fn2) => fn2
     : fn1;
 /**
  * Creates a writable store to be used for an event handler.
+ *
  * @param event - function that will be merged with the value of the store so that it is always called first when the event handler is called
+ * @param prop - the initial value of the store
  * @returns a writable store to be used for an event handler
  */
 const eventStore = (event, prop) => {
@@ -34,6 +36,18 @@ const eventStore = (event, prop) => {
         update: store$.update,
     });
 };
+/**
+ * Call a widget factory using provided configs.
+ *
+ * @param parameter - the parameter
+ * @param parameter.factory - the widget factory to call
+ * @param parameter.$$slots - the slots of the widget
+ * @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
+ * @returns the widget
+ */
 export const callWidgetFactoryWithConfig = ({ factory, $$slots, defaultConfig, widgetConfig, events, $$props, }) => {
     const defaultConfig$ = toReadableStore(defaultConfig);
     const processedSlots = {};
@@ -52,6 +66,12 @@ export const callWidgetFactoryWithConfig = ({ factory, $$slots, defaultConfig, w
     });
     return { ...widget, patchChangedProps: createPatchChangedProps($$props, widget.patch) };
 };
+/**
+ * A type guard checking if a provided slot content is a Svelte component.
+ *
+ * @param content - the slot content
+ * @returns true if the slot content is a svelte component
+ */
 export const isSvelteComponent = (content) => {
     // in prod mode, a svelte component has $set on its prototype
     // in dev mode with hmr (hot module reload), a svelte component has nothing on its prototype, but its name starts with Proxy<