ngx-dynamic-entity-builder 1.10.0 → 1.12.0

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "ngx-dynamic-entity-builder",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "Angular standalone visual builder for authoring dynamic-entity EntityConfig (fields, tabs, validators, RBAC).",
   "//typings": "Local workspace resolution only: ng-packagr 21 writes types/ngx-dynamic-entity-builder.d.ts into dist/package.json. Do NOT add a 'main' field here — ng-packagr does not generate one, so it would be copied verbatim and resolve wrongly in the published package.",
   "typings": "types/ngx-dynamic-entity-builder.d.ts",
   "peerDependencies": {
     "@angular/cdk": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
     "@angular/common": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
-    "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
+    "@angular/core": "^17.2.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
     "@angular/forms": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
     "@angular/material": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0 || ^22.0.0",
-    "@dynamic-entity/core": "^1.10.0",
-    "ngx-dynamic-entity": "^1.10.0",
+    "@dynamic-entity/core": "^1.12.0",
+    "ngx-dynamic-entity": "^1.12.0",
     "rxjs": "^7.0.0"
   },
   "keywords": [

package/types/ngx-dynamic-entity-builder.d.ts

@@ -233,6 +233,15 @@ declare class BuilderStore {
     /** `derived`, or `derived_2`, `derived_3`… if another field already holds it. */
     private availableId;
     setFieldPlaceholder(id: string, language: string, value: string): void;
+    /**
+     * Help text shown under the control, per language.
+     *
+     * Separate from the placeholder for the reason the schema keeps them separate: a
+     * placeholder vanishes the moment the user types, so anything they need *while* filling the
+     * field in cannot live there. An author with only a placeholder box to write in tends to
+     * put it there anyway.
+     */
+    setFieldHint(id: string, language: string, value: string): void;
     toggleFlagValidator(id: string, validator: FlagValidator, on: boolean): void;
     setParamValidator(id: string, validator: ParamValidator, value: number | null): void;
     getParamValidator(field: NestedFieldConfig, validator: ParamValidator): number | null;
@@ -380,8 +389,16 @@ declare const DEFAULT_BUILDER_TEXT: {
     redo: string;
     redoTooltip: string;
     issuesTooltip: string;
+    issuesCount: string;
     copyJson: string;
     save: string;
+    saveBlockedTooltip: string;
+    collapsePalette: string;
+    expandPalette: string;
+    collapseInspector: string;
+    expandInspector: string;
+    paletteRailLabel: string;
+    inspectorRailLabel: string;
     entityName: string;
     entityNamePlaceholder: string;
     editingLanguage: string;
@@ -393,6 +410,16 @@ declare const DEFAULT_BUILDER_TEXT: {
     addField: string;
     fieldProperties: string;
     configJson: string;
+    paletteSearchPlaceholder: string;
+    paletteSearchLabel: string;
+    paletteSearchClear: string;
+    paletteNoMatch: string;
+    paletteGroupBasic: string;
+    paletteGroupChoice: string;
+    paletteGroupDateTime: string;
+    paletteGroupRich: string;
+    paletteGroupStructure: string;
+    paletteGroupOther: string;
     fieldsHeading: string;
     canvasEmpty: string;
     selectField: string;
@@ -415,8 +442,26 @@ declare const DEFAULT_BUILDER_TEXT: {
     tabMoveHint: string;
     labelInLanguage: string;
     placeholderInLanguage: string;
+    hintInLanguage: string;
+    hintHint: string;
     defaultValue: string;
-    validation: string;
+    sectionBasics: string;
+    sectionLayout: string;
+    sectionValidation: string;
+    sectionOptions: string;
+    sectionDisplay: string;
+    sectionVisibility: string;
+    sectionAutomation: string;
+    sectionRules: string;
+    sectionReference: string;
+    width: string;
+    widthQuarter: string;
+    widthThird: string;
+    widthHalf: string;
+    widthTwoThirds: string;
+    widthFull: string;
+    widthHint: string;
+    widthOf: string;
     dataSource: string;
     optionsComeFrom: string;
     optionsSourceNone: string;
@@ -562,6 +607,7 @@ declare class BuilderTextService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<BuilderTextService>;
 }
 
+type RbacAction = 'view' | 'edit' | 'delete';
 /**
  * EntityBuilderComponent — the top-level visual builder for an EntityFormConfig.
  */
@@ -574,6 +620,8 @@ declare class EntityBuilderComponent implements OnChanges {
      * copy of a config the moment it is edited — see `doSave`.
      */
     private readonly configSource;
+    /** Scopes the focus lookup below to this builder, not the first match in the document. */
+    private readonly hostRef;
     /** Existing config to edit. When omitted, the builder starts blank. */
     config?: EntityFormConfig;
     /** Languages available for label/placeholder editing. First entry is the default. */
@@ -600,7 +648,25 @@ declare class EntityBuilderComponent implements OnChanges {
     configChange: EventEmitter<EntityFormConfig>;
     /** Emitted when the user clicks Save. Carries a clean, deep-cloned config. */
     save: EventEmitter<EntityFormConfig>;
-    protected readonly rbacActions: (keyof EntityPermissions)[];
+    protected readonly rbacActions: readonly RbacAction[];
+    readonly leftSidebarOpen: _angular_core.ModelSignal<boolean>;
+    readonly rightSidebarOpen: _angular_core.ModelSignal<boolean>;
+    toggleLeftSidebar(): void;
+    toggleRightSidebar(): void;
+    protected collapseLeft(): void;
+    protected expandLeft(): void;
+    protected collapseRight(): void;
+    protected expandRight(): void;
+    /** The replacement control does not exist until the template has caught up with the signal. */
+    private focusAfterRender;
+    /**
+     * Select the field an issue is about, so reading the message and acting on it are one step.
+     *
+     * A problem without a `fieldId` is about the entity itself — no tabs, a bad entity name —
+     * and there is nothing to select; the template disables those entries rather than silently
+     * doing nothing when one is clicked.
+     */
+    protected selectProblemField(problem: BuilderProblem): void;
     constructor();
     /**
      * Ctrl/Cmd+Z and Ctrl/Cmd+Shift+Z, but only when the user is not typing.
@@ -613,19 +679,53 @@ declare class EntityBuilderComponent implements OnChanges {
     protected doSave(): void;
     protected get json(): string;
     protected copyJson(): void;
-    protected rolesFor(action: keyof EntityPermissions): readonly string[];
-    protected setRoles(action: keyof EntityPermissions, roles: string[]): void;
+    protected rolesFor(action: RbacAction): readonly string[];
+    protected setRoles(action: RbacAction, roles: string[]): void;
     /** Parse a comma-separated role string into a trimmed, de-duplicated array. */
-    protected setRolesFromText(action: keyof EntityPermissions, text: string): void;
+    protected setRolesFromText(action: RbacAction, text: string): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<EntityBuilderComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityBuilderComponent, "ngx-entity-builder", never, { "config": { "alias": "config"; "required": false; }; "languages": { "alias": "languages"; "required": false; }; "uiLanguage": { "alias": "uiLanguage"; "required": false; }; "availableRoles": { "alias": "availableRoles"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; "commonModules": { "alias": "commonModules"; "required": false; }; }, { "configChange": "configChange"; "save": "save"; }, never, ["[ngxBuilderPreview]"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EntityBuilderComponent, "ngx-entity-builder", never, { "config": { "alias": "config"; "required": false; }; "languages": { "alias": "languages"; "required": false; }; "uiLanguage": { "alias": "uiLanguage"; "required": false; }; "availableRoles": { "alias": "availableRoles"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; "commonModules": { "alias": "commonModules"; "required": false; }; "leftSidebarOpen": { "alias": "leftSidebarOpen"; "required": false; "isSignal": true; }; "rightSidebarOpen": { "alias": "rightSidebarOpen"; "required": false; "isSignal": true; }; }, { "configChange": "configChange"; "save": "save"; "leftSidebarOpen": "leftSidebarOpenChange"; "rightSidebarOpen": "rightSidebarOpenChange"; }, never, ["[ngxBuilderPreview]"], true, never>;
 }
 
 /**
- * FieldPaletteComponent — the list of buildable field types (Angular Material).
+ * Which drawer of the palette a field type belongs in.
+ *
+ * Kept here rather than on `FieldTypeMeta` in core: the catalogue is a data model shared with
+ * the renderer, and how a picker arranges twenty-two buttons is a decision about this panel.
+ * A type absent from the map — a consumer's custom type, or one added to core later — falls
+ * into `other`, so the palette degrades to "listed, just not filed" rather than dropping it.
+ */
+declare const PALETTE_GROUPS: readonly ["basic", "choice", "datetime", "rich", "structure", "other"];
+type PaletteGroup = (typeof PALETTE_GROUPS)[number];
+interface PaletteSection {
+    group: PaletteGroup;
+    heading: string;
+    items: FieldTypeMeta[];
+}
+/**
+ * FieldPaletteComponent — the list of buildable field types.
+ *
+ * Two things changed the day this stopped being a flat grid of twenty-two buttons. The labels
+ * were clipped mid-word — "Boolean Toggl", "Entity Referen", "File Attachmen" — because the
+ * grid forced two equal columns and the button refused to wrap, so a third of the palette
+ * could not be read. And with no order to them, finding "Month & Year" meant scanning the
+ * whole list: the grouping and the filter are what make a palette this size navigable.
  */
 declare class FieldPaletteComponent {
+    /** Builder chrome, overridable via BUILDER_TEXT. */
+    protected readonly ui: BuilderTextService;
     readonly catalog: readonly FieldTypeMeta[];
+    /** The filter text. Matched against the label, the type and the description. */
+    protected readonly query: _angular_core.WritableSignal<string>;
+    /**
+     * The catalogue, filtered and filed.
+     *
+     * Matching the description as well as the label is what makes the filter worth having: a
+     * person looking for a currency input types "money", which appears in no label but is
+     * exactly the sort of word a description carries. An empty group is dropped rather than
+     * rendered as a heading with nothing under it.
+     */
+    protected readonly sections: _angular_core.Signal<PaletteSection[]>;
     pick: EventEmitter<RichFieldType>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<FieldPaletteComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<FieldPaletteComponent, "ngx-field-palette", never, {}, { "pick": "pick"; }, never, never, true, never>;
@@ -669,10 +769,51 @@ declare class FieldInspectorComponent {
     protected readonly store: BuilderStore;
     protected readonly field: _angular_core.Signal<NestedFieldConfig>;
     protected readonly meta: _angular_core.Signal<FieldTypeMeta>;
+    /**
+     * The offered widths, as fractions of the 12-column row.
+     *
+     * Five steps rather than all twelve: a free 1–12 spinner is a layout system, and what an
+     * author actually wants is "these two side by side" or "this one across the row". The
+     * fractions that divide twelve evenly cover that, and anything finer stays authorable in
+     * the JSON for the rare case that needs it.
+     */
+    protected readonly spanChoices: readonly [{
+        readonly span: 3;
+        readonly textKey: "widthQuarter";
+    }, {
+        readonly span: 4;
+        readonly textKey: "widthThird";
+    }, {
+        readonly span: 6;
+        readonly textKey: "widthHalf";
+    }, {
+        readonly span: 8;
+        readonly textKey: "widthTwoThirds";
+    }, {
+        readonly span: 12;
+        readonly textKey: "widthFull";
+    }];
     protected lang(): string;
+    /**
+     * How many validators this field actually has, for the section's badge.
+     *
+     * `false` and an empty `custom: []` are both "not set" written the long way — a toggle
+     * switched off leaves the key behind — so neither counts. `0` does: `minLength: 0` is a
+     * value somebody typed.
+     */
+    protected validatorCount(field: NestedFieldConfig): number;
+    /**
+     * How many display flags are set away from their default.
+     *
+     * `visibility` counts when it is *false* and the rest when they are true, because the badge
+     * is meant to say "something here is not the default" — counting `visibility: true` would
+     * put a 1 on every field in the config and tell the author nothing.
+     */
+    protected displayFlagCount(field: NestedFieldConfig): number;
     protected toNum(value: unknown): number | null;
     protected labelValue(field: NestedFieldConfig): string;
     protected placeholderValue(field: NestedFieldConfig): string;
+    protected hintValue(field: NestedFieldConfig): string;
     protected optionLabel(option: DropdownOption): string;
     /**
      * Every tab a field can live on, sub-tabs included.