@openmfp/ngx 0.6.1

package/types/openmfp-ngx.d.ts

@@ -0,0 +1,437 @@
+import * as _angular_core from '@angular/core';
+import { OnInit, OnDestroy, Type } from '@angular/core';
+import { FormGroup, FormControl } from '@angular/forms';
+import * as _openmfp_ngx from '@openmfp/ngx';
+import { Input } from '@fundamental-ngx/ui5-webcomponents/input';
+import { GridStackOptions } from 'gridstack';
+import { nodesCB } from 'gridstack/dist/angular';
+
+interface GenericResource extends Record<string, unknown> {
+    id?: string;
+    isAvailable?: boolean;
+    accessibleName?: string;
+}
+
+type TransformType = 'uppercase' | 'lowercase' | 'capitalize' | 'decode' | 'encode';
+interface PropertyField {
+    key: string;
+    transform?: TransformType[];
+}
+interface UiSettings {
+    labelDisplay?: boolean;
+    displayAs?: 'secret' | 'boolIcon' | 'link' | 'tooltip' | 'alert' | 'img' | 'button';
+    buttonSettings?: ButtonSettings;
+    tooltipIcon?: string;
+    withCopyButton?: boolean;
+    cssCustomization?: Partial<CSSStyleDeclaration>;
+    cssRules?: CssRule[];
+    columnWidth?: string;
+}
+type KnownButtonActions = 'openInModal' | 'navigate' | 'edit' | 'delete';
+type ButtonActions = KnownButtonActions | (string & {});
+interface ButtonSettings {
+    text?: string;
+    icon?: string;
+    endIcon?: string;
+    design?: 'Default' | 'Positive' | 'Negative' | 'Transparent' | 'Emphasized' | 'Attention';
+    tooltip?: string;
+    action: ButtonActions;
+    modalSettings?: ModalSettings;
+}
+interface ModalSettings {
+    title?: string;
+    size?: 'fullscreen' | 'l' | 'm' | 's';
+    width?: string;
+    height?: string;
+}
+type CssRuleCondition = 'equals' | 'notEquals' | 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual' | 'contains';
+interface CssRule {
+    if: {
+        condition: CssRuleCondition;
+        value: string;
+    };
+    styles: Partial<CSSStyleDeclaration>;
+}
+interface ValueCellButtonClickEvent<T extends GenericResource> {
+    event: MouseEvent;
+    field: TableFieldDefinition;
+    resource: T | undefined;
+}
+interface FieldDefinition {
+    label?: string;
+    property?: string | string[];
+    propertyField?: PropertyField;
+    jsonPathExpression?: string;
+    value?: string;
+    uiSettings?: UiSettings;
+}
+interface TableFieldDefinition extends FieldDefinition {
+    group?: {
+        name: string;
+        label?: string;
+        delimiter?: string;
+        multiline?: boolean;
+    };
+}
+
+type GroupBase = NonNullable<TableFieldDefinition['group']>;
+type ProcessedGroup = GroupBase & {
+    fields?: TableFieldDefinition[];
+};
+type ProcessedTableFieldDefinition = Omit<TableFieldDefinition, 'group'> & {
+    group?: ProcessedGroup;
+};
+
+declare class DeclarativeTable<T extends GenericResource> {
+    columns: _angular_core.InputSignal<TableFieldDefinition[]>;
+    resources: _angular_core.InputSignal<T[]>;
+    trackByPath: _angular_core.InputSignal<string>;
+    totalItemsCount: _angular_core.InputSignal<number | undefined>;
+    paginationLimit: _angular_core.InputSignal<number>;
+    hasMore: _angular_core.InputSignal<boolean>;
+    readonly buttonClick: _angular_core.OutputEmitterRef<ValueCellButtonClickEvent<T>>;
+    readonly tableRowClicked: _angular_core.OutputEmitterRef<T>;
+    readonly loadMoreResources: _angular_core.OutputEmitterRef<void>;
+    readonly paginationLimitChanged: _angular_core.OutputEmitterRef<number>;
+    columnTrackBy: (column: TableFieldDefinition, index: number) => string | number | string[];
+    rowTrackBy: (_index: number, item: T) => unknown;
+    viewColumns: _angular_core.Signal<ProcessedTableFieldDefinition[]>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DeclarativeTable<any>, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DeclarativeTable<any>, "mfp-declarative-table", never, { "columns": { "alias": "columns"; "required": true; "isSignal": true; }; "resources": { "alias": "resources"; "required": true; "isSignal": true; }; "trackByPath": { "alias": "trackByPath"; "required": false; "isSignal": true; }; "totalItemsCount": { "alias": "totalItemsCount"; "required": false; "isSignal": true; }; "paginationLimit": { "alias": "paginationLimit"; "required": false; "isSignal": true; }; "hasMore": { "alias": "hasMore"; "required": false; "isSignal": true; }; }, { "buttonClick": "buttonClick"; "tableRowClicked": "tableRowClicked"; "loadMoreResources": "loadMoreResources"; "paginationLimitChanged": "paginationLimitChanged"; }, never, never, true, never>;
+}
+
+interface FormFieldDefinition {
+    name: string;
+    label?: string;
+    required?: boolean;
+    values?: string[];
+    disabled?: boolean;
+    validation?: 'onBlur' | 'onChange';
+}
+interface FormFieldChangeEvent {
+    fieldProperty: string;
+    value: unknown;
+}
+type FormFieldErrors = Record<string, string | null>;
+
+declare class DeclarativeForm {
+    readonly fields: _angular_core.InputSignal<FormFieldDefinition[]>;
+    readonly initialValues: _angular_core.InputSignal<Record<string, unknown>>;
+    readonly fieldErrors: _angular_core.InputSignal<FormFieldErrors>;
+    readonly fieldChange: _angular_core.OutputEmitterRef<FormFieldChangeEvent>;
+    readonly formSubmit: _angular_core.OutputEmitterRef<Record<string, unknown>>;
+    readonly form: FormGroup;
+    private readonly fb;
+    constructor();
+    setFormControlValue($event: Event, field: FormFieldDefinition): void;
+    getError(name: string): string | null;
+    getValueState(name: string): 'None' | 'Negative';
+    onFieldBlur(field: FormFieldDefinition): void;
+    submit(): void;
+    clear(): void;
+    private rebuildControls;
+    private setInitialValues;
+    private buildOutputValue;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DeclarativeForm, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DeclarativeForm, "mfp-declarative-form", never, { "fields": { "alias": "fields"; "required": true; "isSignal": true; }; "initialValues": { "alias": "initialValues"; "required": false; "isSignal": true; }; "fieldErrors": { "alias": "fieldErrors"; "required": false; "isSignal": true; }; }, { "fieldChange": "fieldChange"; "formSubmit": "formSubmit"; }, never, never, true, never>;
+}
+
+interface ResourceFormConfig {
+    fields: FormFieldDefinition[];
+    title?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+interface TableCardFormState {
+    fieldErrors?: FormFieldErrors;
+}
+interface DeleteResourceConfirmationConfig {
+    title?: string;
+    message?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+interface TableConfig {
+    fields: TableFieldDefinition[];
+    totalItemsCount?: number;
+    paginationLimit?: number;
+    hasMore?: boolean;
+}
+interface TableCardButtonSettings {
+    createButton?: Partial<ButtonSettings>;
+    searchButton?: Partial<ButtonSettings>;
+    editButton?: Partial<ButtonSettings>;
+    deleteButton?: Partial<ButtonSettings>;
+}
+interface TableCardConfig {
+    header?: string;
+    headerTooltip?: string;
+    tableConfig: TableConfig;
+    buttonSettings?: TableCardButtonSettings;
+    resourcesSearchable?: boolean;
+    createResourceFormConfig?: ResourceFormConfig;
+    editResourceFormConfig?: ResourceFormConfig;
+    deleteResourceConfirmationConfig?: DeleteResourceConfirmationConfig;
+}
+
+type SearchState = 'collapsed' | 'expanded' | 'collapsing';
+declare class DeclarativeTableCard<T extends GenericResource> {
+    resources: _angular_core.InputSignal<T[]>;
+    config: _angular_core.InputSignal<TableCardConfig>;
+    createFormState: _angular_core.InputSignal<TableCardFormState>;
+    editFormState: _angular_core.InputSignal<TableCardFormState>;
+    readonly actionButtonClick: _angular_core.OutputEmitterRef<ValueCellButtonClickEvent<T>>;
+    readonly tableRowClicked: _angular_core.OutputEmitterRef<T>;
+    readonly loadMoreResources: _angular_core.OutputEmitterRef<void>;
+    readonly paginationLimitChanged: _angular_core.OutputEmitterRef<number>;
+    readonly searchChanged: _angular_core.OutputEmitterRef<string>;
+    readonly createFieldChange: _angular_core.OutputEmitterRef<FormFieldChangeEvent>;
+    readonly editFieldChange: _angular_core.OutputEmitterRef<{
+        resource: T;
+        formChangeEvent: FormFieldChangeEvent;
+    }>;
+    readonly createSubmit: _angular_core.OutputEmitterRef<Record<string, unknown>>;
+    readonly editSubmit: _angular_core.OutputEmitterRef<{
+        resource: T;
+        value: Record<string, unknown>;
+    }>;
+    readonly deleteSubmit: _angular_core.OutputEmitterRef<T>;
+    protected searchState: _angular_core.WritableSignal<SearchState>;
+    protected searchExpanded: _angular_core.Signal<boolean>;
+    protected searchCollapsing: _angular_core.Signal<boolean>;
+    protected searchControl: FormControl<string | null>;
+    protected searchInputRef: _angular_core.Signal<Input | undefined>;
+    protected createDialogOpen: _angular_core.WritableSignal<boolean>;
+    protected editDialogOpen: _angular_core.WritableSignal<boolean>;
+    protected deleteDialogOpen: _angular_core.WritableSignal<boolean>;
+    protected pendingResource: _angular_core.WritableSignal<T | null>;
+    protected tableConfig: _angular_core.Signal<_openmfp_ngx.TableConfig>;
+    protected header: _angular_core.Signal<string | undefined>;
+    protected headerTooltip: _angular_core.Signal<string | undefined>;
+    protected createFormConfig: _angular_core.Signal<_openmfp_ngx.ResourceFormConfig | undefined>;
+    protected editFormConfig: _angular_core.Signal<_openmfp_ngx.ResourceFormConfig | undefined>;
+    protected deleteConfirmationConfig: _angular_core.Signal<_openmfp_ngx.DeleteResourceConfirmationConfig | undefined>;
+    protected createButtonConfig: _angular_core.Signal<Partial<_openmfp_ngx.ButtonSettings> | undefined>;
+    protected searchButtonConfig: _angular_core.Signal<Partial<_openmfp_ngx.ButtonSettings> | undefined>;
+    protected effectiveColumns: _angular_core.Signal<TableFieldDefinition[]>;
+    protected editInitialValue: _angular_core.Signal<Record<string, unknown>>;
+    private readonly injector;
+    constructor();
+    toggleSearch(): void;
+    onSearchBlur(): void;
+    onSearchAnimationEnd(): void;
+    private collapseSearch;
+    onButtonClick(event: ValueCellButtonClickEvent<T>): void;
+    closeCreateDialog(): void;
+    closeEditDialog(): void;
+    closeDeleteDialog(): void;
+    onCreateFieldChange(event: FormFieldChangeEvent): void;
+    onEditFieldChange(event: FormFieldChangeEvent): void;
+    onCreateSubmit(value: Record<string, unknown>): void;
+    onEditSubmit(value: Record<string, unknown>): void;
+    onDeleteSubmit(): void;
+    protected hasErrors(state: TableCardFormState): boolean;
+    private addActionsColumn;
+    private buildInitialValues;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DeclarativeTableCard<any>, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DeclarativeTableCard<any>, "mfp-declarative-table-card", never, { "resources": { "alias": "resources"; "required": true; "isSignal": true; }; "config": { "alias": "config"; "required": true; "isSignal": true; }; "createFormState": { "alias": "createFormState"; "required": false; "isSignal": true; }; "editFormState": { "alias": "editFormState"; "required": false; "isSignal": true; }; }, { "actionButtonClick": "actionButtonClick"; "tableRowClicked": "tableRowClicked"; "loadMoreResources": "loadMoreResources"; "paginationLimitChanged": "paginationLimitChanged"; "searchChanged": "searchChanged"; "createFieldChange": "createFieldChange"; "editFieldChange": "editFieldChange"; "createSubmit": "createSubmit"; "editSubmit": "editSubmit"; "deleteSubmit": "deleteSubmit"; }, never, never, true, never>;
+}
+
+declare const CARD_TYPES: {
+    readonly WC: "wc";
+    readonly ANGULAR: "angular";
+    readonly SAP_UI: "sap-ui";
+};
+type CardsType = (typeof CARD_TYPES)[keyof typeof CARD_TYPES];
+interface CardConfig {
+    id: string;
+    w?: number;
+    h?: number;
+    x?: number;
+    y?: number;
+    maxH?: number;
+    maxW?: number;
+    minH?: number;
+    minW?: number;
+    sectionId?: string;
+    component: string;
+    type?: CardsType;
+    componentInputs?: Record<string, unknown>;
+    label?: string;
+}
+interface SectionConfig {
+    id: string;
+    w?: number;
+    title?: string;
+    editable?: boolean;
+}
+interface DashboardButtonsSettings {
+    editViewButton?: Partial<ButtonSettings>;
+    addCardButton?: Partial<ButtonSettings>;
+}
+interface DashboardConfig {
+    title: string;
+    description?: string;
+    backgroundImageUrl?: string;
+    buttonsSettings?: DashboardButtonsSettings;
+    customActions?: ButtonSettings[];
+    editable?: boolean;
+}
+
+declare class Dashboard implements OnInit, OnDestroy {
+    static registerAngularComponents(componentTypes: Type<unknown>[]): void;
+    config: _angular_core.InputSignal<DashboardConfig>;
+    sections: _angular_core.ModelSignal<SectionConfig[]>;
+    cards: _angular_core.ModelSignal<CardConfig[]>;
+    availableCards: _angular_core.InputSignal<CardConfig[]>;
+    readonly saved: _angular_core.OutputEmitterRef<{
+        sections: SectionConfig[];
+        cards: CardConfig[];
+    }>;
+    readonly actionButtonClick: _angular_core.OutputEmitterRef<{
+        event: MouseEvent;
+        action: ButtonSettings;
+    }>;
+    editMode: _angular_core.WritableSignal<boolean>;
+    compactToolbar: _angular_core.WritableSignal<boolean>;
+    toolbarMenuOpen: _angular_core.WritableSignal<boolean>;
+    private sectionsSnapshot;
+    private cardsSnapshot;
+    private gridStackItems;
+    private resizeObserver?;
+    private readonly hostEl;
+    protected gridOptions: _angular_core.Signal<GridStackOptions>;
+    cardDialogOpen: _angular_core.WritableSignal<boolean>;
+    customActions: _angular_core.Signal<ButtonSettings[]>;
+    addedCardsIds: _angular_core.Signal<Set<string>>;
+    editViewButton: _angular_core.Signal<{
+        text: string;
+        icon: string;
+        endIcon?: string;
+        design: "Default" | "Positive" | "Negative" | "Transparent" | "Emphasized" | "Attention";
+        tooltip: string;
+        action?: (("openInModal" | "navigate" | "edit" | "delete") | (string & {})) | undefined;
+        modalSettings?: _openmfp_ngx.ModalSettings;
+    }>;
+    addCardButton: _angular_core.Signal<{
+        text: string;
+        icon: string;
+        endIcon?: string;
+        design: "Default" | "Positive" | "Negative" | "Transparent" | "Emphasized" | "Attention";
+        tooltip: string;
+        action?: (("openInModal" | "navigate" | "edit" | "delete") | (string & {})) | undefined;
+        modalSettings?: _openmfp_ngx.ModalSettings;
+    }>;
+    sectionCards: _angular_core.Signal<(sectionId: string) => CardConfig[]>;
+    cardsPosition: Map<string, {
+        x?: number;
+        y?: number;
+    }>;
+    looseCards: _angular_core.WritableSignal<CardConfig[]>;
+    private newGridStackNodes;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    onMenuItemClick(actionId: string, event: Event): void;
+    enterEditMode(): void;
+    saveEdit(): void;
+    cancelEdit(): void;
+    removeSection(id: string): void;
+    removeCard(id: string): void;
+    openCardPanel(): void;
+    closeCardPanel(): void;
+    onCardsAdded(cards: CardConfig[]): void;
+    onOrderChange(event: nodesCB): void;
+    private saveCardsPosition;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Dashboard, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Dashboard, "mfp-dashboard", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "sections": { "alias": "sections"; "required": false; "isSignal": true; }; "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "availableCards": { "alias": "availableCards"; "required": false; "isSignal": true; }; }, { "sections": "sectionsChange"; "cards": "cardsChange"; "saved": "saved"; "actionButtonClick": "actionButtonClick"; }, never, never, true, never>;
+}
+
+declare class AddCardDialog {
+    availableCards: _angular_core.InputSignal<CardConfig[]>;
+    addedCardsIds: _angular_core.InputSignal<Set<string>>;
+    open: _angular_core.InputSignal<boolean>;
+    confirm: _angular_core.OutputEmitterRef<CardConfig[]>;
+    cancel: _angular_core.OutputEmitterRef<void>;
+    selectedIds: _angular_core.WritableSignal<Set<string>>;
+    constructor();
+    toggle(id: string): void;
+    confirmAdd(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AddCardDialog, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AddCardDialog, "mfp-add-card-dialog", never, { "availableCards": { "alias": "availableCards"; "required": false; "isSignal": true; }; "addedCardsIds": { "alias": "addedCardsIds"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; }, { "confirm": "confirm"; "cancel": "cancel"; }, never, never, true, never>;
+}
+
+declare class DashboardCard {
+    card: _angular_core.InputSignal<CardConfig>;
+    editMode: _angular_core.InputSignal<boolean>;
+    readonly removeCard: _angular_core.OutputEmitterRef<void>;
+    protected readonly gridColumn: _angular_core.Signal<string>;
+    protected readonly gridRow: _angular_core.Signal<string>;
+    private host;
+    private renderer;
+    constructor();
+    private createGridTrack;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DashboardCard, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DashboardCard, "mfp-dashboard-card", never, { "card": { "alias": "card"; "required": true; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; }, { "removeCard": "removeCard"; }, never, ["*"], true, never>;
+}
+
+declare class DashboardSection {
+    section: _angular_core.InputSignal<SectionConfig>;
+    cards: _angular_core.InputSignal<CardConfig[]>;
+    columns: _angular_core.InputSignal<number>;
+    editMode: _angular_core.InputSignal<boolean>;
+    readonly removeSection: _angular_core.OutputEmitterRef<void>;
+    readonly removeCard: _angular_core.OutputEmitterRef<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DashboardSection, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DashboardSection, "mfp-dashboard-section", never, { "section": { "alias": "section"; "required": true; "isSignal": true; }; "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "columns": { "alias": "columns"; "required": false; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; }, { "removeSection": "removeSection"; "removeCard": "removeCard"; }, never, never, true, never>;
+}
+
+declare class VisitedServiceCard {
+    serviceType: _angular_core.InputSignal<string>;
+    serviceName: _angular_core.InputSignal<string>;
+    serviceDescription: _angular_core.InputSignal<string>;
+    serviceIcon: _angular_core.InputSignal<string>;
+    path: _angular_core.InputSignal<string>;
+    click: _angular_core.OutputEmitterRef<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<VisitedServiceCard, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<VisitedServiceCard, "mfp-visited-service-card", never, { "serviceType": { "alias": "serviceType"; "required": true; "isSignal": true; }; "serviceName": { "alias": "serviceName"; "required": true; "isSignal": true; }; "serviceDescription": { "alias": "serviceDescription"; "required": true; "isSignal": true; }; "serviceIcon": { "alias": "serviceIcon"; "required": true; "isSignal": true; }; "path": { "alias": "path"; "required": true; "isSignal": true; }; }, { "click": "click"; }, never, never, true, never>;
+}
+
+declare class Favorites {
+    readonly items: {
+        label: string;
+        icon: string;
+        action: string;
+    }[];
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Favorites, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Favorites, "mfp-favorites", never, {}, {}, never, never, true, never>;
+}
+
+type ServiceStatusValue = 'operational' | 'degraded' | 'outage' | 'maintenance';
+interface ServiceStatusItem {
+    name: string;
+    icon: string;
+    status: ServiceStatusValue;
+}
+declare class ServiceStatusCard {
+    readonly services: ServiceStatusItem[];
+    readonly statusConfig: Record<ServiceStatusValue, {
+        label: string;
+        icon: string;
+        colorClass: string;
+    }>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ServiceStatusCard, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ServiceStatusCard, "mfp-service-status-card", never, {}, {}, never, never, true, never>;
+}
+
+declare class WhatsNew {
+    readonly headlines: {
+        title: string;
+        description: string;
+        icon: string;
+    }[];
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WhatsNew, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WhatsNew, "mfp-whats-new", never, {}, {}, never, never, true, never>;
+}
+
+export { AddCardDialog, CARD_TYPES, Dashboard, DashboardCard, DashboardSection, DeclarativeForm, DeclarativeTable, DeclarativeTableCard, Favorites, ServiceStatusCard, VisitedServiceCard, WhatsNew };
+export type { ButtonSettings, CardConfig, CardsType, CssRule, CssRuleCondition, DashboardButtonsSettings, DashboardConfig, DeleteResourceConfirmationConfig, FieldDefinition, FormFieldChangeEvent, FormFieldDefinition, FormFieldErrors, GenericResource, ModalSettings, PropertyField, ResourceFormConfig, SectionConfig, ServiceStatusItem, ServiceStatusValue, TableCardButtonSettings, TableCardConfig, TableCardFormState, TableConfig, TableFieldDefinition, TransformType, UiSettings, ValueCellButtonClickEvent };