@igo2/common 20.2.0 → 21.0.0-next.10

package/form/index.d.ts

@@ -1,429 +0,0 @@
-import * as _igo2_common_form from '@igo2/common/form';
-import * as i0 from '@angular/core';
-import { OnChanges, ElementRef, SimpleChanges, OnInit, ModuleWithProviders } from '@angular/core';
-import { ValidatorFn, UntypedFormControl, UntypedFormGroup, AbstractControl } from '@angular/forms';
-import { BehaviorSubject, Observable } from 'rxjs';
-import * as i1 from '@angular/material/dialog';
-import { MatDialogConfig, MatDialogRef } from '@angular/material/dialog';
-import { LanguageService } from '@igo2/core/language';
-
-interface Form {
-    fields: FormField[];
-    groups: FormFieldGroup[];
-    control: UntypedFormGroup;
-}
-interface FormFieldGroupConfig {
-    name: string;
-    title?: string;
-    options?: FormFieldGroupOptions;
-}
-interface FormFieldGroup extends FormFieldGroupConfig {
-    fields: FormField[];
-    control: UntypedFormGroup;
-}
-interface FormFieldGroupOptions {
-    validator?: ValidatorFn;
-    errors?: Record<string, string>;
-}
-interface FormGroupsConfig {
-    name: string;
-    formFieldConfigs: FormFieldConfig[];
-}
-interface FormFieldConfig<T extends FormFieldInputs = FormFieldInputs> {
-    name: string;
-    title: string;
-    type?: string;
-    options?: FormFieldOptions;
-    inputs?: T;
-    subscribers?: FormFieldSubscribers;
-}
-type FormFieldSubscribers = Record<string, FormFieldSubscriber>;
-type FormFieldSubscriber = (options: FormFieldSubscriberOptions) => void;
-interface FormFieldSubscriberOptions {
-    field: FormField;
-    control: UntypedFormControl;
-}
-interface FormField<T extends FormFieldInputs = FormFieldInputs> extends FormFieldConfig<T> {
-    control: UntypedFormControl;
-}
-interface FormFieldOptions {
-    initialValue?: unknown;
-    validator?: ValidatorFn;
-    disabled?: boolean;
-    visible?: boolean;
-    cols?: number;
-    errors?: Record<string, string>;
-    disableSwitch?: boolean;
-}
-interface FormFieldInputs {
-}
-interface FormFieldSelectInputs extends FormFieldInputs {
-    choices: BehaviorSubject<FormFieldSelectChoice[]> | FormFieldSelectChoice[];
-}
-interface FormFieldSelectChoice {
-    value: any;
-    title: string;
-}
-
-/**
- * A configurable form
- */
-declare class FormComponent implements OnChanges {
-    /**
-     * Form
-     */
-    readonly form: i0.InputSignal<Form>;
-    /**
-     * Input data
-     */
-    readonly formData: i0.InputSignal<Record<string, any>>;
-    /**
-     * Form autocomplete
-     */
-    readonly autocomplete: i0.InputSignal<string>;
-    /**
-     * Event emitted when the form is submitted
-     */
-    readonly submitForm: i0.OutputEmitterRef<Record<string, any>>;
-    readonly buttons: i0.Signal<ElementRef<any>>;
-    get hasButtons(): boolean;
-    /**
-     * Is the entity or the template change, recreate the form or repopulate it.
-     * @internal
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * Transform the form data to a feature and emit an event
-     * @param event Form submit event
-     * @internal
-     */
-    onSubmit(): void;
-    getData(): Record<string, any>;
-    private setData;
-    private updateDataWithFormField;
-    /**
-     * Clear form
-     */
-    private clear;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormComponent, "igo-form", never, { "form": { "alias": "form"; "required": false; "isSignal": true; }; "formData": { "alias": "formData"; "required": false; "isSignal": true; }; "autocomplete": { "alias": "autocomplete"; "required": false; "isSignal": true; }; }, { "submitForm": "submitForm"; }, never, ["*", "[formButtons]"], true, never>;
-}
-
-/**
- * @deprecated import the FormComponent directly
- */
-declare class IgoFormFormModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoFormFormModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoFormFormModule, never, [typeof FormComponent], [typeof FormComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoFormFormModule>;
-}
-
-/**
- * A configurable form, optionnally bound to an entity
- * (for example in case of un update). Submitting that form
- * emits an event with the form data but no other operation is performed.
- */
-declare class FormGroupComponent {
-    /**
-     * Form field group
-     */
-    readonly group: i0.InputSignal<FormFieldGroup>;
-    /**
-     * Field placeholder
-     */
-    readonly errors: i0.InputSignal<Record<string, string>>;
-    /**
-     * Form group control
-     */
-    get formControl(): UntypedFormGroup;
-    /**
-     * Return the number of columns a field should occupy.
-     * The maximum allowed is 2, even if the field config says more.
-     * @param field Field
-     * @returns Number of columns
-     * @internal
-     */
-    getFieldColSpan(field: FormField): number;
-    /**
-     * Return the number of columns a field should occupy.
-     * The maximum allowed is 2, even if the field config says more.
-     * @param field Field
-     * @returns Number of columns
-     * @internal
-     */
-    getFieldNgClass(field: FormField): Record<string, boolean>;
-    /**
-     * Get error message
-     */
-    getErrorMessage(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormGroupComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormGroupComponent, "igo-form-group", never, { "group": { "alias": "group"; "required": false; "isSignal": true; }; "errors": { "alias": "errors"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
-}
-
-/**
- * @deprecated import the FormGroupComponent directly
- */
-declare class IgoFormGroupModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoFormGroupModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoFormGroupModule, never, [typeof FormGroupComponent], [typeof FormGroupComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoFormGroupModule>;
-}
-
-/**
- * This component renders the proper form input based on
- * the field configuration it receives.
- */
-declare class FormFieldComponent {
-    private formFieldService;
-    /**
-     * Field configuration
-     */
-    readonly field: i0.InputSignal<FormField<FormFieldInputs>>;
-    /**
-     * Field inputs cache
-     */
-    private fieldInputs;
-    /**
-     * Field subscribers cache
-     */
-    private fieldSubscribers;
-    get fieldOptions(): FormFieldOptions;
-    getFieldComponent(): any;
-    getFieldInputs(): FormFieldInputs;
-    getFieldSubscribers(): FormFieldSubscribers;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormFieldComponent, "igo-form-field", never, { "field": { "alias": "field"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-/**
- * This component renders a select field
- */
-declare class FormFieldSelectComponent implements OnInit {
-    readonly disabled: i0.WritableSignal<boolean>;
-    /**
-     * Select input choices
-     */
-    readonly choices: i0.InputSignal<FormFieldSelectChoice[]>;
-    /**
-     * If the select allow multiple selections
-     */
-    readonly multiple: i0.InputSignal<boolean>;
-    /**
-     * The field's form control
-     */
-    readonly formControl: i0.InputSignal<UntypedFormControl>;
-    /**
-     * Field placeholder
-     */
-    readonly placeholder: i0.InputSignal<string>;
-    /**
-     * Field placeholder
-     */
-    readonly errors: i0.InputSignal<Record<string, string>>;
-    /**
-     * Wheter a disable switch should be available
-     */
-    readonly disableSwitch: i0.InputSignal<boolean>;
-    /**
-     * Whether the field is required
-     */
-    get required(): boolean;
-    ngOnInit(): void;
-    /**
-     * Get error message
-     */
-    getErrorMessage(): string;
-    onDisableSwitchClick(): void;
-    private toggleDisabled;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldSelectComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormFieldSelectComponent, "igo-form-field-select", never, { "choices": { "alias": "choices"; "required": true; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "formControl": { "alias": "formControl"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "errors": { "alias": "errors"; "required": false; "isSignal": true; }; "disableSwitch": { "alias": "disableSwitch"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-/**
- * This component renders a text field
- */
-declare class FormFieldTextComponent implements OnInit {
-    private cdRef;
-    disabled$: BehaviorSubject<boolean>;
-    hide: boolean;
-    private lastTimeoutRequest;
-    /**
-     * The field's form control
-     */
-    readonly formControl: i0.InputSignal<UntypedFormControl>;
-    /**
-     * Field placeholder
-     */
-    readonly placeholder: i0.InputSignal<string>;
-    /**
-     * if the input is a password
-     */
-    readonly isPassword: i0.InputSignal<boolean>;
-    /**
-     * Field placeholder
-     */
-    readonly errors: i0.InputSignal<Record<string, string>>;
-    /**
-     * Wheter a disable switch should be available
-     */
-    readonly disableSwitch: i0.InputSignal<boolean>;
-    /**
-     * Whether the field is required
-     */
-    get required(): boolean;
-    ngOnInit(): void;
-    /**
-     * Get error message
-     */
-    getErrorMessage(): string;
-    onDisableSwitchClick(): void;
-    private toggleDisabled;
-    togglePassword(): void;
-    delayedHide(delayMS?: number): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldTextComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormFieldTextComponent, "igo-form-field-text", never, { "formControl": { "alias": "formControl"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "isPassword": { "alias": "isPassword"; "required": false; "isSignal": true; }; "errors": { "alias": "errors"; "required": false; "isSignal": true; }; "disableSwitch": { "alias": "disableSwitch"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-/**
- * This component renders a textarea field
- */
-declare class FormFieldTextareaComponent implements OnInit {
-    disabled$: BehaviorSubject<boolean>;
-    /**
-     * The field's form control
-     */
-    readonly formControl: i0.InputSignal<UntypedFormControl>;
-    /**
-     * Field placeholder
-     */
-    readonly placeholder: i0.InputSignal<string>;
-    /**
-     * Field placeholder
-     */
-    readonly errors: i0.InputSignal<Record<string, string>>;
-    /**
-     * Wheter a disable switch should be available
-     */
-    readonly disableSwitch: i0.InputSignal<boolean>;
-    /**
-     * Whether the field is required
-     */
-    get required(): boolean;
-    ngOnInit(): void;
-    /**
-     * Get error message
-     */
-    getErrorMessage(): string;
-    onDisableSwitchClick(): void;
-    private toggleDisabled;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldTextareaComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormFieldTextareaComponent, "igo-form-field-textarea", never, { "formControl": { "alias": "formControl"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "errors": { "alias": "errors"; "required": false; "isSignal": true; }; "disableSwitch": { "alias": "disableSwitch"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-declare const FORM_DIRECTIVES: readonly [typeof _igo2_common_form.FormFieldComponent, typeof _igo2_common_form.FormFieldSelectComponent, typeof _igo2_common_form.FormFieldTextComponent, typeof _igo2_common_form.FormFieldTextareaComponent, typeof FormGroupComponent, typeof FormComponent];
-/**
- * @deprecated import the components directly or FORM_DIRECTIVES for every components/directives
- */
-declare class IgoFormModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoFormModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoFormModule, never, [typeof FormFieldComponent, typeof FormFieldSelectComponent, typeof FormFieldTextComponent, typeof FormFieldTextareaComponent, typeof FormGroupComponent, typeof FormComponent], [typeof FormFieldComponent, typeof FormFieldSelectComponent, typeof FormFieldTextComponent, typeof FormFieldTextareaComponent, typeof FormGroupComponent, typeof FormComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoFormModule>;
-}
-
-declare function formControlIsRequired(control: AbstractControl): boolean;
-declare function getDefaultErrorMessages(): Record<string, string>;
-declare function getControlErrorMessage(control: AbstractControl, messages: Record<string, string>): string;
-declare function getAllFormFields(form: Form): FormField[];
-declare function getFormFieldByName(form: Form, name: string): FormField;
-
-declare class FormService {
-    private formBuilder;
-    form(fields: FormField[], groups: FormFieldGroup[]): Form;
-    group(config: FormFieldGroupConfig, fields: FormField[]): FormFieldGroup;
-    field(config: FormFieldConfig): FormField;
-    extendFieldConfig(config: FormFieldConfig, partial: Partial<FormFieldConfig>): FormFieldConfig;
-    private getValidators;
-    private getValidator;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<FormService>;
-}
-
-/**
- * Service where all available form fields are registered.
- */
-declare class FormFieldService {
-    static fields: Record<string, any>;
-    static register(type: string, component: any): void;
-    /**
-     * Return field component by type
-     * @param type Field type
-     * @returns Field component
-     */
-    getFieldByType(type: string): any;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<FormFieldService>;
-}
-
-declare function IgoFormFieldComponent(type: string): (cls: any) => any;
-
-/**
- * @deprecated import the components directly or FORM_FIELD_DIRECTIVES for every components/directives
- */
-declare class IgoFormFieldModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoFormFieldModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoFormFieldModule, never, [typeof FormFieldComponent, typeof FormFieldSelectComponent, typeof FormFieldTextComponent, typeof FormFieldTextareaComponent], [typeof FormFieldComponent, typeof FormFieldSelectComponent, typeof FormFieldTextComponent, typeof FormFieldTextareaComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoFormFieldModule>;
-}
-
-declare const FORM_FIELD_DIRECTIVES: readonly [typeof FormFieldComponent, typeof FormFieldSelectComponent, typeof FormFieldTextComponent, typeof FormFieldTextareaComponent];
-
-interface FormDialogFormConfig {
-    formFieldConfigs?: FormFieldConfig[];
-    formGroupsConfigs?: FormGroupsConfig[];
-}
-interface FormDialogData extends FormDialogOptions, FormDialogFormConfig {
-}
-interface FormDialogOptions extends MatDialogConfig {
-    data$?: BehaviorSubject<Record<string, any>>;
-    title?: string;
-    processButtonText?: string;
-    cancelButtonText?: string;
-    notice?: string;
-}
-
-declare class FormDialogComponent {
-    languageService: LanguageService;
-    dialogRef: MatDialogRef<FormDialogComponent, any>;
-    private formService;
-    data: FormDialogData;
-    form$: BehaviorSubject<Form>;
-    data$: BehaviorSubject<Record<string, any>>;
-    constructor();
-    onSubmit(data: Record<string, any>): void;
-    cancel(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormDialogComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormDialogComponent, "igo-form-dialog", never, {}, {}, never, never, true, never>;
-}
-
-/**
- * @deprecated import the FlexibleComponent directly
- */
-declare class IgoFormDialogModule {
-    /**
-     * @deprecated it has no effect
-     */
-    static forRoot(): ModuleWithProviders<IgoFormDialogModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<IgoFormDialogModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoFormDialogModule, never, [typeof i1.MatDialogModule, typeof FormDialogComponent], [typeof FormDialogComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<IgoFormDialogModule>;
-}
-
-declare class FormDialogService {
-    private dialog;
-    open(formDialogConfig?: FormDialogFormConfig, options?: FormDialogOptions): Observable<Record<string, any>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormDialogService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<FormDialogService>;
-}
-
-export { FORM_DIRECTIVES, FORM_FIELD_DIRECTIVES, FormComponent, FormDialogComponent, FormDialogService, FormFieldComponent, FormFieldSelectComponent, FormFieldService, FormFieldTextComponent, FormFieldTextareaComponent, FormGroupComponent, FormService, IgoFormDialogModule, IgoFormFieldComponent, IgoFormFieldModule, IgoFormFormModule, IgoFormGroupModule, IgoFormModule, formControlIsRequired, getAllFormFields, getControlErrorMessage, getDefaultErrorMessages, getFormFieldByName };
-export type { Form, FormDialogData, FormDialogFormConfig, FormDialogOptions, FormField, FormFieldConfig, FormFieldGroup, FormFieldGroupConfig, FormFieldGroupOptions, FormFieldInputs, FormFieldOptions, FormFieldSelectChoice, FormFieldSelectInputs, FormFieldSubscribers, FormGroupsConfig };