@agnos-ui/angular-headless - npm Package Compare versions

Comparing version 0.0.1-alpha.6 to 0.0.1-alpha.7

config.d.ts

@@ -12,2 +12,10 @@ import type { Widget, WidgetFactory, WidgetProps } from '@agnos-ui/core/types';
 type AdaptParentConfig<Config> = (config: Partial2Levels<Config>) => Partial2Levels<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 widgetsConfigInjectionToken - the widgets config injection token
+ * @returns the utilities to create / manage widgets and contexts
+ */
 export declare const widgetsConfigFactory: <Config extends {
@@ -14,0 +22,0 @@ [widgetName: string]: object;

index.d.ts

@@ -1,9 +0,9 @@
-export * from './components/accordion/accordion';
-export * from './components/alert/alert';
-export * from './components/modal/modal';
-export * from './components/pagination/pagination';
-export * from './components/progressbar/progressbar';
-export * from './components/rating/rating';
-export * from './components/select/select';
-export * from './components/slider/slider';
+export * from './components/accordion';
+export * from './components/alert';
+export * from './components/modal';
+export * from './components/pagination';
+export * from './components/progressbar';
+export * from './components/rating';
+export * from './components/select';
+export * from './components/slider';
 export * from './generated';

package.json

@@ -11,5 +11,2 @@ {
 			"default": "./fesm2022/agnos-ui-angular-headless.mjs"
-		},
-		"./package.json": {
-			"default": "./package.json"
 		}
@@ -22,10 +19,8 @@ },
 	"dependencies": {
-		"@agnos-ui/core": "0.0.1-alpha.6",
-		"@amadeus-it-group/tansu": "0.0.24",
+		"@agnos-ui/core": "0.0.1-alpha.7",
+		"@amadeus-it-group/tansu": "1.0.0",
 		"tslib": "^2.6.2"
 	},
 	"sideEffects": false,
-	"version": "0.0.1-alpha.6",
-	"module": "fesm2022/agnos-ui-angular-headless.mjs",
-	"typings": "index.d.ts",
+	"version": "0.0.1-alpha.7",
 	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",
@@ -32,0 +27,0 @@ "bugs": "https://github.com/AmadeusITGroup/AgnosUI/issues",

slot.directive.d.ts

@@ -11,3 +11,5 @@ import type { OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
     private _slotHandler;
+    /** @inheritdoc */
     ngOnChanges(changes: SimpleChanges): void;
+    /** @inheritdoc */
     ngOnDestroy(): void;
@@ -14,0 +16,0 @@ static ɵfac: i0.ɵɵFactoryDeclaration<SlotDirective<any>, never>;

slotDefault.directive.d.ts

@@ -11,2 +11,3 @@ import type { WritableSignal } from '@amadeus-it-group/tansu';
     templateRef: TemplateRef<any>;
+    /** @inheritdoc */
     ngOnInit(): void;
@@ -13,0 +14,0 @@ static ɵfac: i0.ɵɵFactoryDeclaration<SlotDefaultDirective<any>, never>;

utils/coercion.d.ts

@@ -5,7 +5,6 @@ /**
  *
- *  @usageNotes
- *  ```typescript
- *  @Input({ transform: auBooleanAttribute }) status: boolean | undefined;
- *  ```
- * @param value Value to be transformed.
+ * @example
+ * ```@Input({ transform: auBooleanAttribute }) status: boolean | undefined;```
+ * @param value - Value to be transformed.
+ * @returns the value transformed
  */
@@ -16,9 +15,8 @@ export declare function auBooleanAttribute(value: unknown): boolean | undefined;
  * Intended to be used as a transform function of an input.
- * @param value Value to be transformed.
+ * @param value - Value to be transformed.
  *
- *  @usageNotes
- *  ```typescript
- *  @Input({ transform: auNumberAttribute }) id: number | undefined;
- *  ```
+ * @example
+ *  ```@Input({ transform: auNumberAttribute }) id: number | undefined;```
+ * @returns the value transformed
  */
 export declare function auNumberAttribute(value: unknown): number | undefined;

utils/directive.d.ts

@@ -5,4 +5,11 @@ import type { Directive as AgnosUIDirective } from '@agnos-ui/core/types';
 export * from '@agnos-ui/core/utils/directive';
-export declare const useDirectiveForHost: <T>(use?: AgnosUIDirective<T> | undefined, params?: T | undefined) => {
-    update: (newUse?: AgnosUIDirective<T> | undefined, newParams?: T | undefined) => Promise<void>;
+/**
+ * Set up an agnos-ui directive as an angular host directive.
+ *
+ * @param directive - the directive
+ * @param params - the params to pass to the directive
+ * @returns the update function to change the directive or params
+ */
+export declare const useDirectiveForHost: <T>(directive?: AgnosUIDirective<T> | undefined, params?: T | undefined) => {
+    update: (newDirective?: AgnosUIDirective<T> | undefined, newParams?: T | undefined) => Promise<void>;
 };
@@ -13,2 +20,3 @@ export declare class UseDirective<T> implements OnChanges {
     params: T | undefined;
+    /** @inheritdoc */
     ngOnChanges(): void;
@@ -15,0 +23,0 @@ static ɵfac: i0.ɵɵFactoryDeclaration<UseDirective<any>, never>;

utils/stores.d.ts

 import type { ReadableSignal } from '@amadeus-it-group/tansu';
 import type { Signal } from '@angular/core';
 export * from '@agnos-ui/core/utils/stores';
+/**
+ * Convert a tansu readable signal into an Angular signal.
+ *
+ * @param tansuSignal - a tansu readable signal
+ * @returns an angular signal
+ *
+ * @remarks
+ * Note that as it uses Angular's `inject`, this can only be called at component construction time.
+ */
 export declare const toAngularSignal: <T>(tansuSignal: ReadableSignal<T>) => Signal<T>;

utils/widget.d.ts

@@ -5,2 +5,13 @@ import { type ReadableSignal } from '@amadeus-it-group/tansu';
 import * as i0 from "@angular/core";
+/**
+ * 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.afterInit - a callback to call after successful setup of the widget
+ * @returns the widget
+ */
 export declare const callWidgetFactoryWithConfig: <W extends Widget<object, object, object, object, object>>({ factory, defaultConfig, widgetConfig, events, afterInit, }: {
@@ -17,2 +28,6 @@ factory: WidgetFactory<W>;
  * Applies to: class getters
+ *
+ * @param target - the target
+ * @param property - the property
+ * @param descriptor - the property descriptor
  */
@@ -25,3 +40,5 @@ export declare const CachedProperty: (target: any, property: PropertyKey, descriptor: PropertyDescriptor) => void;
     get widget(): ContextWidget<W>;
+    /** @inheritdoc */
     ngOnChanges(changes: SimpleChanges): void;
+    /** @inheritdoc */
     ngOnInit(): void;
@@ -28,0 +45,0 @@ static ɵfac: i0.ɵɵFactoryDeclaration<BaseWidgetDirective<any>, never>;

utils/zone.d.ts

@@ -6,2 +6,8 @@ import * as i0 from "@angular/core";
     planNgZoneRun: () => void;
+    /**
+     * Run the input function synchronously within the Angular zone
+     *
+     * @param fn - a function to run
+     * @returns the value returned by the function
+     */
     ngZoneRun<T>(fn: () => T): T;
@@ -8,0 +14,0 @@ insideNgZone: Wrapper;

No alert changes

Improved metrics

Total package byte prevSize

220759

increased by6.04%

Number of package files

103

increased by18.39%

Lines of code

1819

increased by9.98%

Dependency changes

• + Added@agnos-ui/core@0.0.1-alpha.7(transitive)

• + Added@amadeus-it-group/tansu@1.0.0(transitive)

• - Removed@agnos-ui/core@0.0.1-alpha.6(transitive)

• - Removed@amadeus-it-group/tansu@0.0.24(transitive)

• Updated@agnos-ui/core@0.0.1-alpha.7

• Updated@amadeus-it-group/tansu@1.0.0