@yuuvis/client-components 3.2.1 → 3.3.0

package/types/yuuvis-client-components-widget-grid.d.ts

@@ -1,48 +1,37 @@
-import * as _angular_core from '@angular/core';
-import { Type, InputSignal, OutputEmitterRef, TemplateRef } from '@angular/core';
-import { GridType, GridsterItemConfig, Gridster, GridsterConfig } from 'angular-gridster2';
 import * as _angular_forms from '@angular/forms';
 import { FormControlStatus, FormControl } from '@angular/forms';
-import { AttributesMap } from 'ng-dynamic-component';
+import * as _angular_core from '@angular/core';
+import { InputSignal, Type, OutputEmitterRef, TemplateRef, OnInit } from '@angular/core';
 import { MatDialogRef } from '@angular/material/dialog';
 import { TranslateService } from '@yuuvis/client-core';
+import { GridType, GridsterItemConfig, Gridster, GridsterConfig } from 'angular-gridster2';
+import { InputsType } from 'ng-dynamic-component';
 import { Observable } from 'rxjs';
 
-interface GridWidget<T> {
-    id: string;
-    label: string;
-    setupComponent?: Type<IWidgetComponent<T>>;
-    widgetComponent: Type<IWidgetComponent<T>>;
-}
-interface WidgetGridItemConfig extends GridsterItemConfig {
-    id: string;
-    widgetName: string;
-    widgetConfig: any;
-}
-interface WidgetGridItem extends WidgetGridItemConfig {
-    widget: Type<any>;
-    widgetConfigMap: AttributesMap;
-}
-interface IWidgetComponent<T> {
-    widgetConfig: InputSignal<T>;
-}
-interface IWidgetSetupComponent<T> extends IWidgetComponent<T> {
-    widgetConfigChange: OutputEmitterRef<T>;
-    widgetConfigStateChange: OutputEmitterRef<FormControlStatus>;
-}
-interface WidgetPickerData {
-    widgetId: string | undefined;
-    widgetName: string;
-    widgetConfigMap?: AttributesMap;
-}
 interface AddItemSize {
     rows: number;
     cols: number;
 }
-interface GridItemEvent {
+
+interface GridItemEvent<T = unknown> {
     action: string;
-    data: any;
+    data: T;
 }
+
+interface IWidgetComponent<T> {
+    widgetConfig: InputSignal<T>;
+}
+
+interface GridWidget<T> {
+    id: string;
+    label: string;
+    description?: string;
+    group?: string;
+    setupComponent?: Type<IWidgetComponent<T>>;
+    widgetComponent: Type<IWidgetComponent<T>>;
+    isApplicable?: () => boolean;
+}
+
 interface WidgetGridConfig {
     rows?: number;
     columns?: number;
@@ -51,58 +40,33 @@ interface WidgetGridConfig {
     newItemHeight?: number;
     gridType?: GridType;
 }
+
+interface WidgetGridItemConfig<T = unknown> extends GridsterItemConfig {
+    id: string;
+    widgetName: string;
+    widgetConfig: T;
+}
+
+interface WidgetGridItem<T extends IWidgetComponent<unknown> = IWidgetComponent<unknown>> extends WidgetGridItemConfig {
+    widget: Type<T>;
+    widgetConfigMap: InputsType;
+    isApplicable: boolean;
+}
+
+interface WidgetPickerData {
+    widgetId: string | undefined;
+    widgetName: string;
+    widgetConfigMap?: InputsType;
+}
+
 interface WidgetPickerOptions {
     pickerData?: WidgetPickerData;
     buckets?: string[];
 }
 
-declare class YuvWidgetGridComponent {
-    #private;
-    gridster: _angular_core.Signal<Gridster | undefined>;
-    widgetPicker: _angular_core.Signal<TemplateRef<any>>;
-    options: GridsterConfig;
-    gridConfig: _angular_core.InputSignal<Partial<WidgetGridConfig> | undefined>;
-    _editMode: _angular_core.WritableSignal<boolean>;
-    /**
-     * Whether or not to enable edit mode. In edit mode controls
-     * for editing existing tiles and creating new ones are shown.
-     * This mode also enables positioning and resizing of the tiles.
-     */
-    editMode: _angular_core.InputSignal<boolean>;
-    gridItemConfig: _angular_core.InputSignal<WidgetGridItemConfig[] | undefined>;
-    /**
-     * Collection of buckets to load available widgets from. Wildcards are also posssible:
-     * `[buckets]="['app.default', '*.public.*', 'app.no?.widgets']"`
-     *
-     * `*` represents any character 0-n times
-     * `?` represents exactly one character
-     */
-    buckets: _angular_core.InputSignal<string[] | undefined>;
-    /**
-     * Emitted when the grid has been changed
-     */
-    gridChange: _angular_core.OutputEmitterRef<WidgetGridItemConfig[]>;
-    gridItemEvent: _angular_core.OutputEmitterRef<GridItemEvent>;
-    /**
-     * Emitted when the widget picker is opened or closed in edit mode
-     */
-    widgetPickerOpen: _angular_core.OutputEmitterRef<boolean>;
-    widgetGrid: Array<WidgetGridItem>;
-    widgetPickerData: WidgetPickerData | undefined;
-    constructor();
-    openWidgetPicker(item?: WidgetGridItem): void;
-    /**
-     * Removes a widget from the grid
-     * @param item The widget to be removed
-     */
-    removeItem(item: WidgetGridItem): void;
-    /**
-     * Add a new widget to the grid by opening the widget picker
-     */
-    addItem(): void;
-    private emitChange;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<YuvWidgetGridComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<YuvWidgetGridComponent, "yuv-widget-grid", never, { "gridConfig": { "alias": "gridConfig"; "required": false; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; "gridItemConfig": { "alias": "gridItemConfig"; "required": false; "isSignal": true; }; "buckets": { "alias": "buckets"; "required": false; "isSignal": true; }; }, { "gridChange": "gridChange"; "gridItemEvent": "gridItemEvent"; "widgetPickerOpen": "widgetPickerOpen"; }, never, [".empty"], true, never>;
+interface IWidgetSetupComponent<T> extends IWidgetComponent<T> {
+    widgetConfigChange: OutputEmitterRef<T>;
+    widgetConfigStateChange: OutputEmitterRef<FormControlStatus>;
 }
 
 interface WidgetGridWorkspace {
@@ -114,10 +78,12 @@ interface WidgetGridWorkspace {
     preventEdit?: boolean;
     preventRename?: boolean;
 }
+
 interface WidgetGridWorkspaceConfig {
     currentWorkspace?: string;
     workspaces: WidgetGridWorkspace[];
 }
+
 interface WidgetGridWorkspaceOptions {
     gridConfig?: Partial<WidgetGridConfig>;
 }
@@ -130,16 +96,6 @@ interface WidgetGridWorkspaceOptions {
 declare class YuvWidgetGridWorkspacesComponent {
     #private;
     readonly translate: TranslateService;
-    workspaceDialogRef?: MatDialogRef<any, any>;
-    workspaceForm: _angular_forms.FormGroup<{
-        id: FormControl<string | null>;
-        label: FormControl<string | null>;
-    }>;
-    get workspaceLabelControl(): FormControl;
-    options: _angular_core.InputSignal<WidgetGridWorkspaceOptions>;
-    _workspaceOptions: _angular_core.Signal<WidgetGridWorkspaceOptions>;
-    workspaceConfig: _angular_core.InputSignal<WidgetGridWorkspaceConfig | undefined>;
-    _workspaceConfig: _angular_core.WritableSignal<WidgetGridWorkspaceConfig | undefined>;
     /**
      * Collection of buckets to load available widgets from. Wildcards are also posssible:
      * `[buckets]="['app.default', '*.public.*', 'app.no?.widgets']"`
@@ -149,30 +105,47 @@ declare class YuvWidgetGridWorkspacesComponent {
      */
     buckets: _angular_core.InputSignal<string[] | undefined>;
     configChange: _angular_core.OutputEmitterRef<WidgetGridWorkspaceConfig | undefined>;
-    gridItemEvent: _angular_core.OutputEmitterRef<GridItemEvent>;
+    gridItemEvent: _angular_core.OutputEmitterRef<GridItemEvent<unknown>>;
     editModeChange: _angular_core.OutputEmitterRef<boolean>;
+    workspaceDialogRef?: MatDialogRef<unknown, unknown>;
+    workspaceForm: _angular_forms.FormGroup<{
+        id: FormControl<string | null>;
+        label: FormControl<string | null>;
+    }>;
+    get workspaceLabelControl(): FormControl;
+    options: _angular_core.InputSignal<WidgetGridWorkspaceOptions>;
+    _workspaceOptions: _angular_core.Signal<WidgetGridWorkspaceOptions>;
+    workspaceConfig: _angular_core.InputSignal<WidgetGridWorkspaceConfig | undefined>;
+    _workspaceConfig: _angular_core.WritableSignal<WidgetGridWorkspaceConfig | undefined>;
     editMode: _angular_core.WritableSignal<boolean>;
     workspace: _angular_core.WritableSignal<WidgetGridWorkspace | undefined>;
     workspaceLabel: _angular_core.WritableSignal<string>;
-    gridItemConfig: _angular_core.WritableSignal<WidgetGridItemConfig[] | undefined>;
+    gridItemConfig: _angular_core.WritableSignal<WidgetGridItemConfig<unknown>[] | undefined>;
+    constructor();
     getLabel(workspace: WidgetGridWorkspace): string;
-    setWorkspace(id: string, silent?: boolean): void;
-    openWorkspaceDialog(create: boolean, tplRef: TemplateRef<any>): void;
-    saveWorkspace(): void;
-    onGridEvent(e: GridItemEvent): void;
-    onGridChange(grid: Array<WidgetGridItemConfig>): void;
-    persistWorkspaceConfig(): void;
-    revertWorkspaceConfig(): void;
-    deleteCurrentWorkspace(): void;
-    emitConfigChange(): void;
+    onSetWorkspace(id: string, silent?: boolean): void;
+    onOpenWorkspaceDialog(create: boolean, tplRef: TemplateRef<unknown>): void;
+    onDeleteCurrentWorkspace(): void;
+    onToggleEditMode(): void;
+    onRevertWorkspaceConfig(): void;
+    /**
+     * Emit current changes and reset original workspace config internally
+     *
+     * @returns void
+     */
+    onPersistWorkspaceConfig(): void;
+    onGridChange(grid: WidgetGridItemConfig[]): void;
+    onGridEvent(gridItemEvent: GridItemEvent): void;
+    onEnableEditMode(): void;
+    onSaveWorkspace(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<YuvWidgetGridWorkspacesComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<YuvWidgetGridWorkspacesComponent, "yuv-widget-grid-workspaces", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "workspaceConfig": { "alias": "workspaceConfig"; "required": false; "isSignal": true; }; "buckets": { "alias": "buckets"; "required": false; "isSignal": true; }; }, { "configChange": "configChange"; "gridItemEvent": "gridItemEvent"; "editModeChange": "editModeChange"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<YuvWidgetGridWorkspacesComponent, "yuv-widget-grid-workspaces", never, { "buckets": { "alias": "buckets"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; "workspaceConfig": { "alias": "workspaceConfig"; "required": false; "isSignal": true; }; }, { "configChange": "configChange"; "gridItemEvent": "gridItemEvent"; "editModeChange": "editModeChange"; }, never, never, true, never>;
 }
 
-declare class YuvWidgetGridModule {
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<YuvWidgetGridModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<YuvWidgetGridModule, never, [typeof YuvWidgetGridComponent, typeof YuvWidgetGridWorkspacesComponent], [typeof YuvWidgetGridComponent, typeof YuvWidgetGridWorkspacesComponent]>;
-    static ɵinj: _angular_core.ɵɵInjectorDeclaration<YuvWidgetGridModule>;
+declare class NoopComponent implements IWidgetComponent<any> {
+    widgetConfig: any;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NoopComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NoopComponent, "yuv-noop", never, { "widgetConfig": { "alias": "widgetConfig"; "required": false; }; }, {}, never, never, true, never>;
 }
 
 /**
@@ -190,7 +163,7 @@ declare class WidgetGridRegistry {
     private registeredWidgets;
     /**
      * Buckets are collection of widget references.
-     * You can put any widget registered gloabally into a bucket. Later on you can grab
+     * You can put any widget registered globally into a bucket. Later on you can grab
      * widgets from a certain bucket. This enables apps to structure their widgets when e.g.
      * using multiple widget grids with their own set of available widgets.
      */
@@ -203,7 +176,7 @@ declare class WidgetGridRegistry {
      * existing component from the widget grid.
      * @returns NoopComponent
      */
-    getNoopWidget(): GridWidget<any>;
+    getNoopWidget(): GridWidget<unknown>;
     /**
      * Setup components are the administrative part of a widget. They
      * are used to set up a widget. Not all the widgets will have a setup
@@ -212,7 +185,7 @@ declare class WidgetGridRegistry {
      * @returns The setup component of a widget. Throws error if there
      * is not widget registered with the given name
      */
-    getWidgetSetupComponent(widgetName: string): Type<any> | undefined;
+    getWidgetSetupComponent(widgetName: string): Type<unknown> | undefined;
     /**
      * Get the component for a widget. This is the component that will
      * be rendered in a grid tile.
@@ -220,7 +193,15 @@ declare class WidgetGridRegistry {
      * @returns The widget component or noop component if there is
      * no component registered with the given name
      */
-    getWidgetComponent(widgetName: string): Type<any>;
+    getWidgetComponent(widgetName: string): typeof NoopComponent | Type<IWidgetComponent<unknown>>;
+    /**
+     * Evaluates whether the widget with the given name is applicable for
+     * the current runtime context. Widgets without an `isApplicable`
+     * predicate are considered applicable. Unknown widgets are reported
+     * as applicable so the noop fallback can still render.
+     * @param widgetName The widgets name
+     */
+    isWidgetApplicable(widgetName: string): boolean;
     /**
      * Adds a new widget to the list of registered widgets. That way
      * you can create custom widgets that are then available to be
@@ -229,15 +210,14 @@ declare class WidgetGridRegistry {
      * @param bucket List of buckets to register to. If a bucket does
      * not exist it'll be created.
      */
-    registerGridWidget(widget: GridWidget<any>, buckets?: string[]): void;
+    registerGridWidget(widget: GridWidget<unknown>, buckets?: string[]): void;
     /**
      * Register a collection of widgets
      * @param widgets The widgets to be registered
      * @param bucket List of buckets to register to. If a bucket does
      * not exist it'll be created.
      */
-    registerGridWidgets(widgets: GridWidget<any>[], buckets?: string[]): void;
-    private _addToBucket;
+    registerGridWidgets(widgets: GridWidget<unknown>[], buckets?: string[]): void;
     removeRegisteredWidget(id: string): void;
     clearRegisteredWidget(): void;
     /**
@@ -247,8 +227,9 @@ declare class WidgetGridRegistry {
      * @param buckets name of buckets to restrict the widgets to
      * @returns Array of grid widgets
      */
-    getRegisteredWidgets(buckets?: string[]): Array<GridWidget<any>>;
+    getRegisteredWidgets(buckets?: string[]): GridWidget<unknown>[];
     private _wildcardMatch;
+    private _addToBucket;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<WidgetGridRegistry, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<WidgetGridRegistry>;
 }
@@ -262,38 +243,92 @@ declare class WidgetGridRegistry {
  * consider using those labels as well.
  */
 declare class WidgetGridService {
-    private widgetGridRegistry;
-    private widgetGrid;
-    private widgetGridSource;
+    #private;
     widgetGrid$: Observable<WidgetGridItem[]>;
-    private widgetGridUpdateSource;
     /**
      * Emitted when the widget grid has been updated
      */
     widgetGridUpdate$: Observable<string>;
-    addItemSize: {
-        rows: number;
-        cols: number;
-    };
-    constructor(widgetGridRegistry: WidgetGridRegistry);
-    setWidgetGrid(gridItemConfig: Array<WidgetGridItemConfig> | undefined): void;
+    addItemSize: AddItemSize;
+    setWidgetGrid(gridItemConfig: WidgetGridItemConfig[] | undefined): void;
     /**
      * Update config of an existing widget
      * @param widgetId ID of the widget to be updated
      * @param setupWidgetConfig The updated configuration for that widget
      */
-    updateWidget(widgetId: string, setupWidgetConfig: any): void;
-    replaceWidget(widgetId: string, widgetName: string, setupWidgetConfig?: any): void;
+    updateWidget(widgetId: string, setupWidgetConfig: unknown): void;
+    replaceWidget(widgetId: string, widgetName: string, setupWidgetConfig?: unknown): void;
     /**
      * Add a new grid item to the widget grid.
      * @param widgetName The name of the grid item to be added
      * @param setupWidgetConfig
      */
-    addWidget(widgetName: string, setupWidgetConfig?: any): void;
+    addWidget(widgetName: string, setupWidgetConfig?: unknown): void;
     removeWidget(gridItemId: string): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<WidgetGridService, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<WidgetGridService>;
 }
 
+declare class YuvWidgetGridComponent implements OnInit {
+    #private;
+    gridster: _angular_core.Signal<Gridster | undefined>;
+    widgetPicker: _angular_core.Signal<TemplateRef<any>>;
+    gridConfig: _angular_core.InputSignal<Partial<WidgetGridConfig> | undefined>;
+    _editMode: _angular_core.WritableSignal<boolean>;
+    /**
+     * Whether or not to enable edit mode. In edit mode controls
+     * for editing existing tiles and creating new ones are shown.
+     * This mode also enables positioning and resizing of the tiles.
+     */
+    editMode: _angular_core.InputSignal<boolean>;
+    gridItemConfig: _angular_core.InputSignal<WidgetGridItemConfig<unknown>[] | undefined>;
+    /**
+     * Collection of buckets to load available widgets from. Wildcards are also possible:
+     * `[buckets]="['app.default', '*.public.*', 'app.no?.widgets']"`
+     *
+     * `*` represents any character 0-n times
+     * `?` represents exactly one character
+     */
+    buckets: _angular_core.InputSignal<string[] | undefined>;
+    /**
+     * Emitted when the grid has been changed
+     */
+    gridChange: _angular_core.OutputEmitterRef<WidgetGridItemConfig<unknown>[]>;
+    gridItemEvent: _angular_core.OutputEmitterRef<GridItemEvent<unknown>>;
+    /**
+     * Emitted when the widget picker is opened or closed in edit mode
+     */
+    widgetPickerOpen: _angular_core.OutputEmitterRef<boolean>;
+    /**
+     * Held as a signal so gridster's `options` InputSignal sees a new reference
+     * whenever edit mode or grid config changes. Mutating the inner object would
+     * keep the same reference and gridster's `$options` computed would never
+     * recompute — leaving draggable/resizable stuck at their initial `false`.
+     */
+    options: _angular_core.WritableSignal<GridsterConfig>;
+    widgetGrid: WidgetGridItem[];
+    widgetPickerData: WidgetPickerData | undefined;
+    constructor();
+    ngOnInit(): void;
+    onOpenWidgetPicker(item?: WidgetGridItem): void;
+    /**
+     * Removes a widget from the grid
+     * @param item The widget to be removed
+     */
+    onRemoveItem(item: WidgetGridItem): void;
+    /**
+     * Add a new widget to the grid by opening the widget picker
+     */
+    onAddItem(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<YuvWidgetGridComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<YuvWidgetGridComponent, "yuv-widget-grid", never, { "gridConfig": { "alias": "gridConfig"; "required": false; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; "gridItemConfig": { "alias": "gridItemConfig"; "required": false; "isSignal": true; }; "buckets": { "alias": "buckets"; "required": false; "isSignal": true; }; }, { "gridChange": "gridChange"; "gridItemEvent": "gridItemEvent"; "widgetPickerOpen": "widgetPickerOpen"; }, never, [".empty"], true, never>;
+}
+
+declare class YuvWidgetGridModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<YuvWidgetGridModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<YuvWidgetGridModule, never, [typeof YuvWidgetGridComponent, typeof YuvWidgetGridWorkspacesComponent], [typeof YuvWidgetGridComponent, typeof YuvWidgetGridWorkspacesComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<YuvWidgetGridModule>;
+}
+
 export { WidgetGridRegistry, WidgetGridService, YuvWidgetGridComponent, YuvWidgetGridModule, YuvWidgetGridWorkspacesComponent };
 export type { AddItemSize, GridItemEvent, GridWidget, IWidgetComponent, IWidgetSetupComponent, WidgetGridConfig, WidgetGridItem, WidgetGridItemConfig, WidgetGridWorkspace, WidgetGridWorkspaceConfig, WidgetGridWorkspaceOptions, WidgetPickerData, WidgetPickerOptions };