@meshmakers/octo-ui 3.5.430 → 3.5.440

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshmakers/octo-ui",
-  "version": "3.5.430",
+  "version": "3.5.440",
   "peerDependencies": {
     "@ngx-translate/core": "^17.0.0 || ^18.0.0",
     "@angular/animations": "^22.0.0",

package/types/meshmakers-octo-ui-entity-forms.d.ts

@@ -81,6 +81,17 @@ interface EntityFormSectionDef {
     collapsed?: boolean | null;
     columns?: number | null;
 }
+/**
+ * Host hint under a field (AB#7423): informational text, optionally with one action link, e.g.
+ * "Overridden elsewhere - this value is deployed: 1Gi" + "Open values.yaml". Never affects validity.
+ */
+interface EntityFormFieldHint {
+    text: string;
+    /** Label of the action link; without it the hint is plain text. */
+    actionLabel?: string;
+    /** Passed back with `fieldHintAction` when the link is activated. */
+    actionId?: string;
+}
 interface EntityFormFieldDef {
     attributePath: string;
     sectionKey?: string | null;
@@ -255,6 +266,11 @@ interface ResolvedEntityForm {
     formRtId?: string;
     formWellKnownName?: string;
     rtCkTypeId: string;
+    /**
+     * Ancestor CK type ids of {@link rtCkTypeId} (nearest first), as read from the CK metadata.
+     * Lets host cross-field validators target a base type (AB#7422).
+     */
+    ckTypeAncestors?: string[];
     formTargetCkTypeId: string;
     isAbstract: boolean;
     includeDerivedTypes: boolean;
@@ -693,6 +709,66 @@ declare class EntityFormDataService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<EntityFormDataService>;
 }
 
+/**
+ * Form-level (cross-field) validation hook of `mm-entity-form` (AB#7422).
+ *
+ * The per-field rules of a form definition (`required`, `min`, `max`, `pattern`) cannot express a
+ * rule over several fields, e.g. "request must not exceed limit". A host registers an
+ * {@link EntityFormCrossFieldValidator} for the CK types it knows; the library stays free of any
+ * domain knowledge. The validator is re-run on every value change and answers one message per
+ * offending field. Each named field is marked invalid (the message is shown under it, immediately,
+ * without waiting for the user to touch it) and the form cannot be saved until the validator
+ * answers `null` / an empty object.
+ */
+interface EntityFormCrossFieldContext {
+    /**
+     * Current values of the enabled (visible, writable) fields, keyed by field key — for attribute
+     * fields the camelCase attribute name. Values are form values (strings, numbers, booleans, ...).
+     */
+    readonly values: Readonly<Record<string, unknown>>;
+    /** The resolved form (metadata only). */
+    readonly form: ResolvedEntityForm;
+    readonly mode: EntityFormMode;
+}
+/**
+ * Messages by field: the key is a field key or an attribute name (any casing), the value the
+ * text shown under that field. Unknown keys and keys of disabled fields are ignored.
+ */
+type EntityFormCrossFieldErrors = Readonly<Record<string, string>>;
+interface EntityFormCrossFieldValidator {
+    /**
+     * CK type ids (`System.Communication/DeployableWorkload`, case-insensitive) the validator applies
+     * to. A form matches when its concrete runtime type **or one of that type's ancestors** is listed,
+     * so a rule on a base type also covers every derived type.
+     */
+    readonly ckTypeIds: readonly string[];
+    /** Pure function of the context. A throwing validator is ignored (logged once per call). */
+    validate(context: EntityFormCrossFieldContext): EntityFormCrossFieldErrors | null | undefined;
+}
+/** Entry of {@link ENTITY_FORM_CROSS_FIELD_VALIDATORS}: one validator or a list of them. */
+type EntityFormCrossFieldValidatorProvision = EntityFormCrossFieldValidator | readonly EntityFormCrossFieldValidator[];
+/**
+ * Multi token of host validators (root or lazy route). Prefer {@link provideEntityFormCrossFieldValidators}.
+ * The `crossFieldValidators` input of `mm-entity-form` is applied in addition to these.
+ */
+declare const ENTITY_FORM_CROSS_FIELD_VALIDATORS: InjectionToken<EntityFormCrossFieldValidatorProvision>;
+/** Registers validators on a route or at root; several registrations add up. */
+declare function provideEntityFormCrossFieldValidators(...validators: EntityFormCrossFieldValidator[]): EnvironmentProviders;
+/** Flattens the injected multi-provider value (`null` / single / list entries). */
+declare function flattenCrossFieldValidators(provided: EntityFormCrossFieldValidatorProvision | readonly EntityFormCrossFieldValidatorProvision[] | null | undefined): EntityFormCrossFieldValidator[];
+/** True when the validator applies to the form's concrete type or one of its ancestors. */
+declare function crossFieldValidatorApplies(validator: EntityFormCrossFieldValidator, form: ResolvedEntityForm): boolean;
+/**
+ * Runs every applicable validator and maps the answer to field keys. The first message per field
+ * wins (validators run in registration order). Names that match no field are dropped.
+ */
+declare function runCrossFieldValidators(validators: readonly EntityFormCrossFieldValidator[], form: ResolvedEntityForm, fields: readonly ResolvedField[], values: Readonly<Record<string, unknown>>, mode: EntityFormMode): Record<string, string>;
+/**
+ * Host hints on fields (AB#7423): evaluated on the current values of the form on every change. The result is keyed
+ * by field key or attribute name (any casing); unknown keys are ignored. `mm-entity-form` input `fieldHints`.
+ */
+type EntityFormFieldHintsProvider = (context: EntityFormCrossFieldContext) => Readonly<Record<string, EntityFormFieldHint>> | null | undefined;
+
 /**
  * What a label belongs to (AB#5623):
  * - `formTitle` / `formDescription` — the form's name and description (`key` = the form key, else
@@ -910,6 +986,9 @@ declare class EntityFormComponent {
     private readonly keyRingConfigured;
     private readonly injectedLabelResolver;
     private readonly injectedBeforeSave;
+    private readonly injectedCrossFieldValidators;
+    private readonly host;
+    private readonly injector;
     private readonly unsetPlaceholders;
     readonly model: _angular_core.InputSignal<ResolvedEntityForm>;
     readonly mode: _angular_core.InputSignal<EntityFormMode>;
@@ -936,6 +1015,29 @@ declare class EntityFormComponent {
      * token), so set it there when the page saves. See `EntityFormBeforeSaveHook`.
      */
     readonly beforeSave: _angular_core.InputSignal<EntityFormBeforeSaveHook | null | undefined>;
+    /**
+     * Host cross-field validators (AB#7422), applied in addition to the ones registered with
+     * `provideEntityFormCrossFieldValidators` / `ENTITY_FORM_CROSS_FIELD_VALIDATORS`. A validator
+     * names the fields that break a rule over several fields; those fields are invalid (message
+     * shown immediately) and the form cannot be saved until the rule holds.
+     */
+    readonly crossFieldValidators: _angular_core.InputSignal<readonly EntityFormCrossFieldValidator[] | null | undefined>;
+    /**
+     * Host marks on fields (AB#7422), e.g. the field named by the last failed deployment: key = field
+     * key or attribute name (any casing), value = the text shown under the field. A mark is
+     * informational — it never blocks saving — and disappears as soon as the user edits that field.
+     */
+    readonly fieldErrors: _angular_core.InputSignal<Readonly<Record<string, string>> | null | undefined>;
+    /**
+     * Host hints under fields (AB#7423): called with the current values of the form on every change; the
+     * returned hints (text and an optional action link) are shown under their fields. Informational only.
+     */
+    readonly fieldHints: _angular_core.InputSignal<EntityFormFieldHintsProvider | null | undefined>;
+    /** The action link of a field hint was activated (`actionId` as given by the host, `key` = field key). */
+    readonly fieldHintAction: _angular_core.OutputEmitterRef<{
+        key: string;
+        actionId: string;
+    }>;
     readonly changeSetChange: _angular_core.OutputEmitterRef<EntityFormChangeSet>;
     readonly validChange: _angular_core.OutputEmitterRef<boolean>;
     readonly dirtyChange: _angular_core.OutputEmitterRef<boolean>;
@@ -958,6 +1060,12 @@ declare class EntityFormComponent {
     /** Raw values (disabled controls included) for VisibleWhen evaluation. */
     private readonly rawValues;
     private readonly collapsed;
+    /** Current cross-field errors by field key (the control validators read it; see {@link refreshCrossFieldErrors}). */
+    private crossFieldErrorMap;
+    /** Host field marks by field key. */
+    protected readonly hostFieldMarks: _angular_core.Signal<Readonly<Record<string, string>>>;
+    /** Host hints by field key, re-evaluated when the values change. */
+    protected readonly hostHints: _angular_core.Signal<Readonly<Record<string, EntityFormFieldHint>>>;
     /** Keys of the fields whose stored value was an unset placeholder (AB#5623); they start empty. */
     protected readonly unsetPlaceholderFields: _angular_core.WritableSignal<ReadonlySet<string>>;
     /** attributeNames of secrets whose clear is staged for the next save (Q8). */
@@ -1009,8 +1117,19 @@ declare class EntityFormComponent {
     isDirty(): boolean;
     /** True when every enabled control is valid and nothing blocks saving ({@link saveBlockedReason}). */
     isValid(): boolean;
-    /** Marks every control as touched so validation errors become visible. */
+    /**
+     * Marks every control as touched so validation errors become visible and moves the focus to the
+     * first invalid field (AB#7422), expanding its section when it is collapsed.
+     */
     markAllAsTouched(): void;
+    /** Focuses the first invalid, visible field in reading order. Returns its key, or `null`. */
+    focusFirstInvalid(): string | null;
+    /**
+     * Focuses the editor of a visible field (key or attribute name, any casing), expanding its section when it
+     * is collapsed (AB#7423, e.g. a hint's action link that leads to another field). Returns the field key, or
+     * `null` when there is no such visible field.
+     */
+    focusField(name: string): string | null;
     /** Rebuilds the form from the current inputs, discarding user edits. */
     reset(): void;
     /**
@@ -1023,6 +1142,10 @@ declare class EntityFormComponent {
      */
     patchValues(values: EntityFormPrefillValues): string[];
     protected control(key: string): FormControl<unknown>;
+    /** Host mark of the field (shown while the field is pristine), or `null`. */
+    protected hostMark(field: ResolvedField): string | null;
+    protected hintOf(field: ResolvedField): EntityFormFieldHint | null;
+    protected onHintAction(field: ResolvedField, actionId: string): void;
     protected isFieldVisible(field: ResolvedField): boolean;
     protected visibleFieldCount(section: ResolvedSection): number;
     protected isCollapsed(section: ResolvedSection): boolean;
@@ -1062,12 +1185,19 @@ declare class EntityFormComponent {
      * is enabled unless it is read-only.
      */
     private applyVisibility;
+    /** One validator per control that reports the current cross-field error of its field. */
+    private installCrossFieldValidators;
+    /**
+     * Re-runs the cross-field validators on the enabled values and re-validates exactly the
+     * controls whose error changed (`emitEvent: false`: no event loop; the caller bumps / emits).
+     */
+    private refreshCrossFieldErrors;
     /** Values of enabled controls only (hidden and read-only fields are absent). */
     private enabledValues;
     private emitState;
     private bump;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityFormComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityFormComponent, "mm-entity-form", never, { "model": { "alias": "model"; "required": true; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "state": { "alias": "state"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "messages": { "alias": "messages"; "required": false; "isSignal": true; }; "records": { "alias": "records"; "required": false; "isSignal": true; }; "labelResolver": { "alias": "labelResolver"; "required": false; "isSignal": true; }; "initialValues": { "alias": "initialValues"; "required": false; "isSignal": true; }; "beforeSave": { "alias": "beforeSave"; "required": false; "isSignal": true; }; }, { "changeSetChange": "changeSetChange"; "validChange": "validChange"; "dirtyChange": "dirtyChange"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityFormComponent, "mm-entity-form", never, { "model": { "alias": "model"; "required": true; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "state": { "alias": "state"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "messages": { "alias": "messages"; "required": false; "isSignal": true; }; "records": { "alias": "records"; "required": false; "isSignal": true; }; "labelResolver": { "alias": "labelResolver"; "required": false; "isSignal": true; }; "initialValues": { "alias": "initialValues"; "required": false; "isSignal": true; }; "beforeSave": { "alias": "beforeSave"; "required": false; "isSignal": true; }; "crossFieldValidators": { "alias": "crossFieldValidators"; "required": false; "isSignal": true; }; "fieldErrors": { "alias": "fieldErrors"; "required": false; "isSignal": true; }; "fieldHints": { "alias": "fieldHints"; "required": false; "isSignal": true; }; }, { "fieldHintAction": "fieldHintAction"; "changeSetChange": "changeSetChange"; "validChange": "validChange"; "dirtyChange": "dirtyChange"; }, never, never, true, never>;
 }
 
 type EntityFormGetReferenceOptionsQueryVariablesDto = Types.Exact<{
@@ -2693,5 +2823,5 @@ declare function toCkTypeInfo(raw: RawCkType): CkTypeInfo;
 /** Maps a raw `entityFormGetCkRecord` item to {@link CkRecordInfo}. */
 declare function toCkRecordInfo(raw: RawCkRecord): CkRecordInfo;
 
-export { BUILT_IN_DEFAULT_FORM, DEFAULT_ENTITY_FORMS_MESSAGES, DEFAULT_GENERATED_SECTION_TITLE, DEFAULT_SECTION_KEY, ENTITY_FORM_ACTION_CONFIRMATION, ENTITY_FORM_BEFORE_SAVE, ENTITY_FORM_DANGER_CONFIRMATION, ENTITY_FORM_FALLBACK_FORMS, ENTITY_FORM_LABEL_RESOLVER, ENTITY_FORM_SECRET_KEY_RING_CONFIGURED, ENTITY_FORM_SECRET_PLACEHOLDER_VALUES, ENTITY_FORM_UNSET_PLACEHOLDER_VALUES, ENTITY_LIST_ROW_CLASS, ENTITY_PAGE_NEW, ENTITY_PAGE_TYPE_QUERY_PARAM, EntityFormComponent, EntityFormDataService, EntityFormRecordsFieldComponent, EntityFormReferenceFieldComponent, EntityFormSaveVeto, EntityFormSecretEditorComponent, EntityFormService, EntityListComponent, EntityListDataSourceDirective, EntityPageActionsDirective, EntityPageComponent, GENERATED_SECTION_KEY, SYSTEM_PROPERTIES, associationFieldKey, associationRoleName, autoEditorFor, buildChangeSet, canonicaliseEntityFormPrefill, canonicalisePath, ckTypeDisplayName, ckTypeShortName, confirmEntityFormAction, confirmEntityFormDanger, entityDeleteConfirmation, entityFormCatalog, entityFormKey, entityFormPrefillState, entityFormRoutes, entityFormTypeTitles, entityFormUnsetPlaceholderFields, entityFormUnsetPlaceholderLookup, entityListAttributeNames, entityListCreateLabel, entityListIncludesDerivedTypes, formatEntityFormsMessage, humanizeCkTypeName, isChainEndForm, isEditorCompatible, isEntityFormSaveVeto, isEntityFormUnsetPlaceholder, isSecretMetaData, isVisible, localizeEntityForm, localizeEntityFormTitle, localizeEntityListColumns, mergeEntityFormPrefill, mergeEntityFormsMessages, parseDefault, parseEntityForm, parseEntityForms, parseVisibleWhen, pickEntityForm, provideEntityFormFallbacks, resolveEntityForm, resolveEntityFormLabel, resolveListDefaultSort, runEntityFormBeforeSave, secretMetaDataMarker, secretStatusLabelsOf, selectFallbackForms, shortTypeName, toAttributeInputs, toCkRecordInfo, toCkTypeInfo, toEntityListColumn, toEntityListRow, toFormValue, toKebabTypeKey, toListViewRowClass, withFallbackForms };
-export type { BuildChangeSetOptions, CanonicalPath, CkAssociationRoleInfo, CkAttributeInfo, CkRecordInfo, CkTypeInfo, EntityFormActionConfirmation, EntityFormActionRequest, EntityFormBeforeSaveContext, EntityFormBeforeSaveHook, EntityFormBeforeSaveOutcome, EntityFormBeforeSaveResult, EntityFormCatalogEntry, EntityFormChangeSet, EntityFormColumnDef, EntityFormDangerConfirmation, EntityFormDefinition, EntityFormEditor, EntityFormFieldDef, EntityFormLabelKind, EntityFormLabelRequest, EntityFormLabelResolver, EntityFormLoadKey, EntityFormLoadResult, EntityFormMode, EntityFormPrefillOptions, EntityFormPrefillValues, EntityFormRecordColumn, EntityFormReferenceValue, EntityFormRoutesOptions, EntityFormSecretFieldState, EntityFormSectionDef, EntityFormSortDef, EntityFormSource, EntityFormTargetRef, EntityFormUnsetPlaceholderLookup, EntityFormUnsetPlaceholderTarget, EntityFormUnsetPlaceholderValues, EntityFormValueState, EntityFormsMessages, EntityListBooleanDisplay, EntityListCellLabels, EntityListColumnOptions, EntityListCreateRequest, EntityListOpenAction, EntityListOpenRequest, EntityListRow, EntityListRowClass, EntityListSortDescriptor, EntityPageActionBarPosition, EntityPageActionsContext, EntityPageDeletedEvent, EntityPageEditMode, EntityPageInitialValues, EntityPageNavigateEvent, EntityPageSavedEvent, EntityPageView, RawRtEntityRow, ReadOnlyMode, ResolveEntityFormOptions, ResolvedEntityForm, ResolvedField, ResolvedListColumn, ResolvedSection, VisibleWhenRule };
+export { BUILT_IN_DEFAULT_FORM, DEFAULT_ENTITY_FORMS_MESSAGES, DEFAULT_GENERATED_SECTION_TITLE, DEFAULT_SECTION_KEY, ENTITY_FORM_ACTION_CONFIRMATION, ENTITY_FORM_BEFORE_SAVE, ENTITY_FORM_CROSS_FIELD_VALIDATORS, ENTITY_FORM_DANGER_CONFIRMATION, ENTITY_FORM_FALLBACK_FORMS, ENTITY_FORM_LABEL_RESOLVER, ENTITY_FORM_SECRET_KEY_RING_CONFIGURED, ENTITY_FORM_SECRET_PLACEHOLDER_VALUES, ENTITY_FORM_UNSET_PLACEHOLDER_VALUES, ENTITY_LIST_ROW_CLASS, ENTITY_PAGE_NEW, ENTITY_PAGE_TYPE_QUERY_PARAM, EntityFormComponent, EntityFormDataService, EntityFormRecordsFieldComponent, EntityFormReferenceFieldComponent, EntityFormSaveVeto, EntityFormSecretEditorComponent, EntityFormService, EntityListComponent, EntityListDataSourceDirective, EntityPageActionsDirective, EntityPageComponent, GENERATED_SECTION_KEY, SYSTEM_PROPERTIES, associationFieldKey, associationRoleName, autoEditorFor, buildChangeSet, canonicaliseEntityFormPrefill, canonicalisePath, ckTypeDisplayName, ckTypeShortName, confirmEntityFormAction, confirmEntityFormDanger, crossFieldValidatorApplies, entityDeleteConfirmation, entityFormCatalog, entityFormKey, entityFormPrefillState, entityFormRoutes, entityFormTypeTitles, entityFormUnsetPlaceholderFields, entityFormUnsetPlaceholderLookup, entityListAttributeNames, entityListCreateLabel, entityListIncludesDerivedTypes, flattenCrossFieldValidators, formatEntityFormsMessage, humanizeCkTypeName, isChainEndForm, isEditorCompatible, isEntityFormSaveVeto, isEntityFormUnsetPlaceholder, isSecretMetaData, isVisible, localizeEntityForm, localizeEntityFormTitle, localizeEntityListColumns, mergeEntityFormPrefill, mergeEntityFormsMessages, parseDefault, parseEntityForm, parseEntityForms, parseVisibleWhen, pickEntityForm, provideEntityFormCrossFieldValidators, provideEntityFormFallbacks, resolveEntityForm, resolveEntityFormLabel, resolveListDefaultSort, runCrossFieldValidators, runEntityFormBeforeSave, secretMetaDataMarker, secretStatusLabelsOf, selectFallbackForms, shortTypeName, toAttributeInputs, toCkRecordInfo, toCkTypeInfo, toEntityListColumn, toEntityListRow, toFormValue, toKebabTypeKey, toListViewRowClass, withFallbackForms };
+export type { BuildChangeSetOptions, CanonicalPath, CkAssociationRoleInfo, CkAttributeInfo, CkRecordInfo, CkTypeInfo, EntityFormActionConfirmation, EntityFormActionRequest, EntityFormBeforeSaveContext, EntityFormBeforeSaveHook, EntityFormBeforeSaveOutcome, EntityFormBeforeSaveResult, EntityFormCatalogEntry, EntityFormChangeSet, EntityFormColumnDef, EntityFormCrossFieldContext, EntityFormCrossFieldErrors, EntityFormCrossFieldValidator, EntityFormCrossFieldValidatorProvision, EntityFormDangerConfirmation, EntityFormDefinition, EntityFormEditor, EntityFormFieldDef, EntityFormFieldHint, EntityFormFieldHintsProvider, EntityFormLabelKind, EntityFormLabelRequest, EntityFormLabelResolver, EntityFormLoadKey, EntityFormLoadResult, EntityFormMode, EntityFormPrefillOptions, EntityFormPrefillValues, EntityFormRecordColumn, EntityFormReferenceValue, EntityFormRoutesOptions, EntityFormSecretFieldState, EntityFormSectionDef, EntityFormSortDef, EntityFormSource, EntityFormTargetRef, EntityFormUnsetPlaceholderLookup, EntityFormUnsetPlaceholderTarget, EntityFormUnsetPlaceholderValues, EntityFormValueState, EntityFormsMessages, EntityListBooleanDisplay, EntityListCellLabels, EntityListColumnOptions, EntityListCreateRequest, EntityListOpenAction, EntityListOpenRequest, EntityListRow, EntityListRowClass, EntityListSortDescriptor, EntityPageActionBarPosition, EntityPageActionsContext, EntityPageDeletedEvent, EntityPageEditMode, EntityPageInitialValues, EntityPageNavigateEvent, EntityPageSavedEvent, EntityPageView, RawRtEntityRow, ReadOnlyMode, ResolveEntityFormOptions, ResolvedEntityForm, ResolvedField, ResolvedListColumn, ResolvedSection, VisibleWhenRule };