@ngneers/controls 0.0.1-next.0

package/types/ngneers-controls-edit-inplace.d.ts

@@ -0,0 +1,263 @@
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
+import * as _ngneers_signal_translate from '@ngneers/signal-translate';
+import * as _ngneers_controls_api_ng from '@ngneers/controls/api/ng';
+import * as _ngneers_controls_themes from '@ngneers/controls-themes';
+import { ValueControlBase } from '@ngneers/controls/base';
+
+type EditTemplateType = {
+    $implicit: {
+        close: () => void;
+        value: string;
+        update: (value: string) => void;
+    };
+};
+type DisplayTemplateType = {
+    $implicit: {
+        value: string;
+    };
+};
+
+declare abstract class EditInplaceTemplates extends ValueControlBase<'editInplace', string> {
+    private readonly _defaultDisplayTemplate;
+    private readonly _userDisplayTemplate;
+    /**
+     * Set a custom template for the display.
+     * Can also be set using an `<ng-template>` element with `#display` template reference variable.
+     */
+    readonly templateDisplay: _angular_core.InputSignal<TemplateRef<DisplayTemplateType> | null>;
+    protected readonly displayTemplate: _angular_core.Signal<TemplateRef<DisplayTemplateType>>;
+    private readonly _defaultEditTemplate;
+    private readonly _userEditTemplate;
+    /**
+     * Set a custom template for the edit view.
+     * Can also be set using an `<ng-template>` element with `#edit` template reference variable.
+     */
+    readonly templateEdit: _angular_core.InputSignal<TemplateRef<EditTemplateType> | null>;
+    protected readonly editTemplate: _angular_core.Signal<TemplateRef<EditTemplateType>>;
+    /**
+     * Types for the edit-inplace templates.
+     */
+    readonly templateTypes: {
+        /**
+         * Type of the template variable for the display template.
+         */
+        display: DisplayTemplateType;
+        /**
+         * Type of the template variable for the edit template.
+         */
+        edit: EditTemplateType;
+    } & {
+        $implicit: {
+            display: Partial<DisplayTemplateType>;
+            edit: Partial<EditTemplateType>;
+        };
+    };
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EditInplaceTemplates, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<EditInplaceTemplates, never, never, { "templateDisplay": { "alias": "templateDisplay"; "required": false; "isSignal": true; }; "templateEdit": { "alias": "templateEdit"; "required": false; "isSignal": true; }; }, {}, ["_userDisplayTemplate", "_userEditTemplate"], never, true, never>;
+}
+
+/**
+ * @category control
+ */
+declare class NgnEditInplace extends EditInplaceTemplates {
+    protected readonly theme: _ngneers_controls_api_ng.ControlTemplateInfo<_ngneers_controls_themes.ControlTemplate<"edit-inplace", ["root", "disabled", "readonly", "invalid", "default-display", "default-fallback-display", "default-edit", "default-edit-input", "default-edit-close-button", "sr-only"], readonly [{
+        readonly class: "inplace";
+        readonly template: _ngneers_controls_themes.ControlTemplate<"inplace", ["root", "content", "display", "disabled"], readonly []>;
+    }]>>;
+    protected readonly i18n: _ngneers_signal_translate.TranslationsSignal<{
+        calendar: {
+            today: string;
+            input: string;
+            selectYear: string;
+            selectMonth: string;
+            previousMonth: string;
+            nextMonth: string;
+            weekdays: {
+                monday: string;
+                tuesday: string;
+                wednesday: string;
+                thursday: string;
+                friday: string;
+                saturday: string;
+                sunday: string;
+            };
+            weekdaysShort: {
+                monday: string;
+                tuesday: string;
+                wednesday: string;
+                thursday: string;
+                friday: string;
+                saturday: string;
+                sunday: string;
+            };
+            months: {
+                january: string;
+                february: string;
+                march: string;
+                april: string;
+                may: string;
+                june: string;
+                july: string;
+                august: string;
+                september: string;
+                october: string;
+                november: string;
+                december: string;
+            };
+        };
+        editInplace: {
+            placeholder: string;
+            confirm: string;
+        };
+        filter: {
+            noFilter: string;
+            addCondition: string;
+            removeCondition: string;
+            operator: string;
+            value: string;
+            clear: string;
+            apply: string;
+            cancel: string;
+            matchModeLabel: string;
+            match: {
+                all: string;
+                any: string;
+                and: string;
+                or: string;
+            };
+            selected: string;
+            conditions: string;
+            operators: {
+                isEqual: string;
+                isNotEqual: string;
+                contains: string;
+                startsWith: string;
+                endsWith: string;
+                in: string;
+                isEmpty: string;
+                isNotEmpty: string;
+                greaterThan: string;
+                greaterThanOrEqual: string;
+                lessThan: string;
+                lessThanOrEqual: string;
+                after: string;
+                onOrAfter: string;
+                before: string;
+                onOrBefore: string;
+                isTrue: string;
+                isFalse: string;
+                custom: string;
+            };
+        };
+        splitter: {
+            handleLabel: string;
+        };
+        inputField: {
+            clearInput: string;
+        };
+        maskInput: {
+            roleDescription: string;
+            segmentRange: string;
+            optionSeparator: string;
+        };
+        drawer: {
+            close: string;
+        };
+        dialog: {
+            close: string;
+        };
+        chip: {
+            close: string;
+        };
+        breadcrumb: {
+            overflow: string;
+        };
+        toast: {
+            close: string;
+            region: string;
+        };
+        snackbar: {
+            close: string;
+            region: string;
+            severity: {
+                error: string;
+                warning: string;
+                success: string;
+                info: string;
+            };
+        };
+        upload: {
+            upload: string;
+            uploadNamed: string;
+            retryNamed: string;
+            cancelNamed: string;
+            removeNamed: string;
+            progressNamed: string;
+        };
+        select: {
+            filterOptions: string;
+        };
+        paginator: {
+            previousPage: string;
+            nextPage: string;
+        };
+        listBox: {
+            noItemsFound: string;
+        };
+        tree: {
+            noItemsFound: string;
+        };
+        table: {
+            selectAllRows: string;
+            selectRow: string;
+            sortedBy: string;
+            sortAscending: string;
+            sortDescending: string;
+            sortCleared: string;
+            selectedCount: string;
+            page: string;
+            resultCount: string;
+        };
+        state: {
+            loading: string;
+            success: string;
+            warning: string;
+            error: string;
+            cancelled: string;
+        };
+    }, "_">;
+    protected readonly closeContent: () => void;
+    /**
+     * Controls the visibility of the content.
+     */
+    readonly editVisible: _angular_core.ModelSignal<boolean>;
+    /**
+     * Whether the content is loaded lazily.
+     * @default true
+     */
+    readonly lazy: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Whether the content is cached when closed.
+     * @default false
+     */
+    readonly cache: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Switches to the edit view.
+     */
+    switchToEdit(): void;
+    /**
+     * Switches to the display view.
+     */
+    switchToDisplay(): void;
+    /**
+     * Toggles between the display and content views.
+     */
+    toggle(): void;
+    protected focusOut(event: FocusEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgnEditInplace, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgnEditInplace, "ngn-edit-inplace", never, { "editVisible": { "alias": "editVisible"; "required": false; "isSignal": true; }; "lazy": { "alias": "lazy"; "required": false; "isSignal": true; }; "cache": { "alias": "cache"; "required": false; "isSignal": true; }; }, { "editVisible": "editVisibleChange"; }, never, never, true, never>;
+}
+
+export { NgnEditInplace };
+export type { DisplayTemplateType, EditTemplateType };

package/types/ngneers-controls-errors.d.ts

@@ -0,0 +1,155 @@
+import * as _angular_core from '@angular/core';
+import { Signal, InjectionToken, Provider } from '@angular/core';
+import { NgnHint } from '@ngneers/controls/hint';
+import { ValidationErrors } from '@angular/forms';
+
+/**
+ * Origin of a normalized validation error.
+ * @category types
+ */
+type NgnErrorsSource = 'control' | 'group' | 'custom';
+/**
+ * Interaction state that controls when validation messages are visible.
+ * @category types
+ */
+type NgnErrorsShowOn = 'touched' | 'dirty' | 'submitted' | 'always' | 'never';
+/**
+ * Message aggregation mode for visible errors.
+ * @category types
+ */
+type NgnErrorsMode = 'first' | 'all';
+/**
+ * Static or computed message for a validation error key.
+ * @category types
+ */
+type NgnErrorsMessage = string | ((error: NgnErrorsMessageContext) => string | null | undefined);
+/**
+ * Map of validation error keys to message resolvers.
+ * @category types
+ */
+type NgnErrorsMessages = Record<string, NgnErrorsMessage>;
+/**
+ * Custom errors supplied directly to ngnErrors.
+ * @category types
+ */
+type NgnErrorsCustom = ValidationErrors | readonly (string | NgnErrorsCustomEntry)[] | null | undefined;
+/**
+ * Custom error entry with optional value, params, and explicit message.
+ * @category types
+ */
+interface NgnErrorsCustomEntry {
+    key: string;
+    value?: unknown;
+    message?: string;
+    params?: Record<string, unknown>;
+}
+/**
+ * Normalized validation error exposed by ngnErrors.
+ * @category types
+ */
+interface NgnError {
+    key: string;
+    value: unknown;
+    source: NgnErrorsSource;
+    message: string;
+    params: Record<string, unknown>;
+}
+/**
+ * Context passed to computed validation message resolvers.
+ * @category types
+ */
+interface NgnErrorsMessageContext {
+    key: string;
+    value: unknown;
+    source: NgnErrorsSource;
+    params: Record<string, unknown>;
+}
+/**
+ * Current validation state that can be bridged into hint controls.
+ * @category types
+ */
+interface NgnErrorsState {
+    visible: boolean;
+    pending: boolean;
+    errors: readonly NgnError[];
+    firstError: NgnError | null;
+    message: string | null;
+}
+
+declare class NgnErrors {
+    /**
+     * Hint instance that receives the resolved validation state.
+     * @category inputs
+     */
+    readonly ngnErrorsHint: _angular_core.InputSignal<NgnHint | undefined>;
+    /**
+     * Interaction state that controls when errors become visible.
+     * @category inputs
+     */
+    readonly ngnErrorsShowOn: _angular_core.InputSignal<NgnErrorsShowOn>;
+    /**
+     * Whether to show the first matching error or all messages.
+     * @category inputs
+     */
+    readonly ngnErrorsMode: _angular_core.InputSignal<NgnErrorsMode>;
+    /**
+     * Per-instance messages that override globally provided defaults.
+     * @category inputs
+     */
+    readonly ngnErrorsMessages: _angular_core.InputSignal<NgnErrorsMessages | null>;
+    /**
+     * Additional errors supplied independently of Angular form validation.
+     * @category inputs
+     */
+    readonly ngnErrorsCustom: _angular_core.InputSignal<NgnErrorsCustom>;
+    private readonly _ngControl;
+    private readonly _selfContainer;
+    private readonly _parentContainer;
+    private readonly _ngnControl;
+    private readonly _globalMessages;
+    private readonly _version;
+    readonly errors: Signal<readonly NgnError[]>;
+    readonly firstError: Signal<NgnError | null>;
+    readonly pending: Signal<boolean>;
+    readonly visible: Signal<boolean>;
+    readonly message: Signal<string | null>;
+    readonly state: Signal<NgnErrorsState>;
+    constructor();
+    private _watchControl;
+    private _hostControl;
+    private _parentControl;
+    private _rootControl;
+    private _submittedSource;
+    private _submitted;
+    private _normalizeGroupErrors;
+    private _normalizeCustomErrors;
+    private _normalizeErrors;
+    private _createCustomEntryError;
+    private _createError;
+    private _isGroupErrorRelevant;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgnErrors, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgnErrors, "[ngnErrors]", ["ngnErrors"], { "ngnErrorsHint": { "alias": "ngnErrorsHint"; "required": false; "isSignal": true; }; "ngnErrorsShowOn": { "alias": "ngnErrorsShowOn"; "required": false; "isSignal": true; }; "ngnErrorsMode": { "alias": "ngnErrorsMode"; "required": false; "isSignal": true; }; "ngnErrorsMessages": { "alias": "ngnErrorsMessages"; "required": false; "isSignal": true; }; "ngnErrorsCustom": { "alias": "ngnErrorsCustom"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Multi-provider token for validation error message maps.
+ * @category providers
+ */
+declare const NGN_ERRORS_MESSAGES: InjectionToken<readonly NgnErrorsMessages[]>;
+/**
+ * Provide custom validation error messages that are merged with defaults.
+ * @category providers
+ */
+declare function provideNgnErrorsMessages(messages: NgnErrorsMessages): Provider;
+/**
+ * Inject all provided validation message maps as a single merged object.
+ * @category providers
+ */
+declare function injectNgnErrorsMessages(): NgnErrorsMessages;
+declare const defaultNgnErrorsMessages: NgnErrorsMessages;
+declare function resolveNgnErrorMessage(context: NgnErrorsMessageContext, messages: NgnErrorsMessages): string;
+declare function paramsFromValue(value: unknown): Record<string, unknown>;
+declare function isRecord(value: unknown): value is Record<string, unknown>;
+
+export { NGN_ERRORS_MESSAGES, NgnErrors, defaultNgnErrorsMessages, injectNgnErrorsMessages, isRecord, paramsFromValue, provideNgnErrorsMessages, resolveNgnErrorMessage };
+export type { NgnError, NgnErrorsCustom, NgnErrorsCustomEntry, NgnErrorsMessage, NgnErrorsMessageContext, NgnErrorsMessages, NgnErrorsMode, NgnErrorsShowOn, NgnErrorsSource, NgnErrorsState };