@masterteam/form-builder 0.0.54 → 0.0.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masterteam/form-builder",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "publishConfig": {
     "directory": "../../../dist/masterteam/form-builder",
     "linkDirectory": true,
@@ -19,10 +19,9 @@
     "rxjs": "^7.8.2",
     "tailwindcss": "^4.2.2",
     "tailwindcss-primeui": "^0.6.1",
-    "@masterteam/properties": "^0.0.90",
-    "@masterteam/components": "^0.0.301",
-    "@masterteam/icons": "^0.0.17",
-    "@masterteam/forms": "^0.0.156"
+    "@masterteam/components": "^0.0.311",
+    "@masterteam/forms": "^0.0.163",
+    "@masterteam/icons": "^0.0.17"
   },
   "sideEffects": false,
   "exports": {

package/types/masterteam-form-builder.d.ts

@@ -51,7 +51,14 @@ interface FormField {
     _pending?: boolean;
     _deleting?: boolean;
 }
-type FormBuilderMode = 'builder' | 'manageProperties';
+/**
+ * - `builder` — the full editor over a module's form configuration.
+ * - `manageProperties` — read/write permissions and size only.
+ * - `localFields` — an in-memory field list a host seeds and reads back (see
+ *   `EnterLocalFormConfiguration`): one section, order / size / required, and
+ *   nothing is sent to the form-configuration API.
+ */
+type FormBuilderMode = 'builder' | 'manageProperties' | 'localFields';
 interface FormSection {
     id: string;
     name: {
@@ -202,12 +209,24 @@ interface FormBuilderStateModel extends LoadingStateShape<FormBuilderActionKey>
      * moduleId on `ResetFormBuilderState`.
      */
     contextResolveExtraParams: Record<string, unknown> | null;
+    /**
+     * Field edits change this state only, never the form-configuration API. Set
+     * by `EnterLocalFormConfiguration` for a host that owns the result itself —
+     * the Local EntityList field list is the case this exists for.
+     */
+    localMode: boolean;
+    /**
+     * The state a local session set aside, restored by
+     * `ExitLocalFormConfiguration`. The store is global, so a host that edits a
+     * local field list while a real builder page is loaded must not clobber it.
+     */
+    stashedState: Omit<FormBuilderStateModel, 'stashedState'> | null;
 }
 
 declare class FormBuilderFacade {
     private readonly store;
     private readonly stateSignal;
-    readonly formConfiguration: _angular_core.Signal<_masterteam_form_builder.FormConfiguration | null>;
+    readonly formConfiguration: _angular_core.Signal<FormConfiguration | null>;
     readonly sections: _angular_core.Signal<_masterteam_form_builder.FormSection[]>;
     readonly properties: _angular_core.Signal<PropertyItem[]>;
     readonly validations: _angular_core.Signal<_masterteam_form_builder.ValidationRule[]>;
@@ -217,6 +236,8 @@ declare class FormBuilderFacade {
     readonly parentModuleId: _angular_core.Signal<string | number | null>;
     readonly parentPath: _angular_core.Signal<string>;
     readonly previewInfo: _angular_core.Signal<PreviewInfo | null>;
+    /** True while a host edits a field list in memory; see `enterLocalConfiguration`. */
+    readonly localMode: _angular_core.Signal<boolean>;
     readonly contextResolveExtraParams: _angular_core.Signal<Record<string, unknown> | null>;
     readonly isLoadingFormConfiguration: _angular_core.Signal<boolean>;
     readonly isResettingFormConfiguration: _angular_core.Signal<boolean>;
@@ -241,6 +262,9 @@ declare class FormBuilderFacade {
     readonly validationError: _angular_core.Signal<string | null>;
     setModuleInfo(moduleType: string, moduleId: string | number, parentModuleType?: string, parentModuleId?: string | number, parentPath?: string): rxjs.Observable<void>;
     resetState(): rxjs.Observable<void>;
+    /** See `EnterLocalFormConfiguration`. Pair every call with `exitLocalConfiguration`. */
+    enterLocalConfiguration(formConfiguration: FormConfiguration, properties: PropertyItem[]): rxjs.Observable<void>;
+    exitLocalConfiguration(): rxjs.Observable<void>;
     setProperties(properties: PropertyItem[]): rxjs.Observable<void>;
     setPreviewInfo(payload: PreviewInfo): rxjs.Observable<void>;
     /**
@@ -291,8 +315,15 @@ declare class FormBuilder implements OnInit {
     private readonly popovers;
     /** Extra CSS class(es) applied to the main canvas wrapper div. */
     readonly canvasStyleClass: _angular_core.InputSignal<string>;
-    /** Operating mode: 'builder' (full editor) or 'manageProperties' (read/write permissions only). */
-    readonly mode: _angular_core.InputSignal<FormBuilderMode>;
+    /**
+     * Operating mode: 'builder' (full editor), 'manageProperties' (read/write
+     * permissions only) or 'localFields' (a host-owned field list).
+     *
+     * A missing value means 'builder'. Hosts mount this component straight on a
+     * route, and `withComponentInputBinding()` sets every input the route does
+     * not supply to `undefined`, which would otherwise hide the whole toolbar.
+     */
+    readonly mode: _angular_core.InputSignalWithTransform<FormBuilderMode, FormBuilderMode | null | undefined>;
     /** Controls the draggable properties sidebar independently from the main builder canvas. */
     readonly showPropertiesSection: _angular_core.InputSignalWithTransform<boolean, unknown>;
     private dialogRef;
@@ -323,6 +354,12 @@ declare class FormBuilder implements OnInit {
     private initialContextStateCleared;
     private readonly contextKey;
     readonly propertiesSectionVisible: _angular_core.Signal<boolean>;
+    /**
+     * A host-owned field list (see `FormBuilderFacade.enterLocalConfiguration`):
+     * the toolbox lists the properties the host seeded instead of resolving a
+     * context, and nothing reaches the form-configuration API.
+     */
+    readonly isLocalFields: _angular_core.Signal<boolean>;
     private readonly usedPropertyKeys;
     private readonly propertiesMap;
     /** Navigation options from initial context */
@@ -390,6 +427,8 @@ declare class FormBuilder implements OnInit {
     removeScopePath(_scope?: ScopeKey): void;
     /** Template-compatible version (returns properties array for the scope) */
     getScopeProperties(_scope?: ScopeKey): PropertyItem[];
+    /** The Current scope's toolbox: the resolved context, or the host's list. */
+    private currentScopeProperties;
     getFilteredProperties(_scope?: ScopeKey): PropertyItem[];
     isScopePropertiesLoading(_scope?: ScopeKey): boolean;
     getPropertyLabel(property: PropertyItem): string;
@@ -441,6 +480,20 @@ declare class SetModuleInfo {
 declare class ResetFormBuilderState {
     static readonly type = "[FormBuilder] Reset State";
 }
+/**
+ * Start editing a field list in memory: the given configuration and the
+ * properties its toolbox offers. Field actions stop calling the API until
+ * `ExitLocalFormConfiguration`, which restores whatever was loaded before.
+ */
+declare class EnterLocalFormConfiguration {
+    formConfiguration: FormConfiguration;
+    properties: PropertyItem[];
+    static readonly type = "[FormBuilder] Enter Local Form Configuration";
+    constructor(formConfiguration: FormConfiguration, properties: PropertyItem[]);
+}
+declare class ExitLocalFormConfiguration {
+    static readonly type = "[FormBuilder] Exit Local Form Configuration";
+}
 declare class SetProperties {
     properties: PropertyItem[];
     static readonly type = "[FormBuilder] Set Properties";
@@ -568,37 +621,55 @@ declare class FormBuilderState extends CrudStateBase<FormSection, FormBuilderSta
     setContextResolveExtraParams(ctx: StateContext<FormBuilderStateModel>, action: SetContextResolveExtraParams): void;
     setProperties(ctx: StateContext<FormBuilderStateModel>, action: SetProperties): void;
     setPreviewInfo(ctx: StateContext<FormBuilderStateModel>, action: SetPreviewInfo): void;
-    getFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>>;
-    resetFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>>;
-    resetFormFromAppForm(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>>;
+    /**
+     * The store is global, so whatever a real builder page had loaded is set
+     * aside rather than overwritten, and comes back on exit. Re-entering while
+     * already local keeps the original stash.
+     */
+    enterLocalFormConfiguration(ctx: StateContext<FormBuilderStateModel>, action: EnterLocalFormConfiguration): void;
+    exitLocalFormConfiguration(ctx: StateContext<FormBuilderStateModel>): void;
+    /** Apply `update` to one section's fields, renumbering `order` by position. */
+    private patchLocalFields;
+    /**
+     * A property can sit on the form once, so its key makes a stable id for a
+     * field that was never saved anywhere.
+     */
+    private addLocalField;
+    private updateLocalField;
+    private deleteLocalField;
+    private reorderLocalFields;
+    private moveLocalField;
+    getFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>> | undefined;
+    resetFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>> | undefined;
+    resetFormFromAppForm(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>> | undefined;
     updateFormSettings(ctx: StateContext<FormBuilderStateModel>, action: UpdateFormSettings): rxjs.Observable<Response$1<FormConfiguration>> | undefined;
-    addSection(ctx: StateContext<FormBuilderStateModel>, action: AddSection): rxjs.Observable<Response$1<FormSection>>;
-    updateSection(ctx: StateContext<FormBuilderStateModel>, action: UpdateSection): rxjs.Observable<Response$1<FormSection>>;
+    addSection(ctx: StateContext<FormBuilderStateModel>, action: AddSection): rxjs.Observable<Response$1<FormSection>> | undefined;
+    updateSection(ctx: StateContext<FormBuilderStateModel>, action: UpdateSection): rxjs.Observable<Response$1<FormSection>> | undefined;
     reorderSections(ctx: StateContext<FormBuilderStateModel>, action: ReorderSections): rxjs.Observable<Response$1<{
         sections: FormSection[];
-    }>>;
+    }>> | undefined;
     deleteSection(ctx: StateContext<FormBuilderStateModel>, action: DeleteSection): rxjs.Observable<Response$1<{
         id: string;
-    }>>;
-    addField(ctx: StateContext<FormBuilderStateModel>, action: AddField): rxjs.Observable<Response$1<FormField>>;
-    updateField(ctx: StateContext<FormBuilderStateModel>, action: UpdateField): rxjs.Observable<Response$1<FormField>>;
-    deleteField(ctx: StateContext<FormBuilderStateModel>, action: DeleteField): rxjs.Observable<Response$1<{
+    }>> | undefined;
+    addField(ctx: StateContext<FormBuilderStateModel>, action: AddField): void | rxjs.Observable<Response$1<FormField>>;
+    updateField(ctx: StateContext<FormBuilderStateModel>, action: UpdateField): void | rxjs.Observable<Response$1<FormField>>;
+    deleteField(ctx: StateContext<FormBuilderStateModel>, action: DeleteField): void | rxjs.Observable<Response$1<{
         id: string;
         sectionId: string;
     }>>;
-    reorderFields(ctx: StateContext<FormBuilderStateModel>, action: ReorderFields): rxjs.Observable<Response$1<{
+    reorderFields(ctx: StateContext<FormBuilderStateModel>, action: ReorderFields): void | rxjs.Observable<Response$1<{
         fields: FormField[];
     }>>;
-    moveField(ctx: StateContext<FormBuilderStateModel>, action: MoveField): rxjs.Observable<Response$1<FormField>>;
-    addValidation(ctx: StateContext<FormBuilderStateModel>, action: AddValidation): rxjs.Observable<Response$1<ValidationRule>>;
-    updateValidation(ctx: StateContext<FormBuilderStateModel>, action: UpdateValidation): rxjs.Observable<Response$1<ValidationRule>>;
+    moveField(ctx: StateContext<FormBuilderStateModel>, action: MoveField): void | rxjs.Observable<Response$1<FormField>>;
+    addValidation(ctx: StateContext<FormBuilderStateModel>, action: AddValidation): rxjs.Observable<Response$1<ValidationRule>> | undefined;
+    updateValidation(ctx: StateContext<FormBuilderStateModel>, action: UpdateValidation): rxjs.Observable<Response$1<ValidationRule>> | undefined;
     deleteValidation(ctx: StateContext<FormBuilderStateModel>, action: DeleteValidation): rxjs.Observable<Response$1<{
         id: string | number;
-    }>>;
-    toggleValidationActive(ctx: StateContext<FormBuilderStateModel>, action: ToggleValidationActive): rxjs.Observable<Response$1<ValidationRule>>;
+    }>> | undefined;
+    toggleValidationActive(ctx: StateContext<FormBuilderStateModel>, action: ToggleValidationActive): rxjs.Observable<Response$1<ValidationRule>> | undefined;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderState, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<FormBuilderState>;
 }
 
-export { AddField, AddSection, AddValidation, DeleteField, DeleteSection, DeleteValidation, FormBuilder, FormBuilderActionKey, FormBuilderFacade, FormBuilderState, GetFormConfiguration, MoveField, ReorderFields, ReorderSections, ResetFormBuilderState, ResetFormConfiguration, ResetFormFromAppForm, SetContextResolveExtraParams, SetModuleInfo, SetPreviewInfo, SetProperties, ToggleValidationActive, UpdateField, UpdateFormSettings, UpdateSection, UpdateValidation };
+export { AddField, AddSection, AddValidation, DeleteField, DeleteSection, DeleteValidation, EnterLocalFormConfiguration, ExitLocalFormConfiguration, FormBuilder, FormBuilderActionKey, FormBuilderFacade, FormBuilderState, GetFormConfiguration, MoveField, ReorderFields, ReorderSections, ResetFormBuilderState, ResetFormConfiguration, ResetFormFromAppForm, SetContextResolveExtraParams, SetModuleInfo, SetPreviewInfo, SetProperties, ToggleValidationActive, UpdateField, UpdateFormSettings, UpdateSection, UpdateValidation };
 export type { AddFieldPayload, AddSectionPayload, AddValidationPayload, EnrichedFormField, EnrichedFormSection, FieldWidth, FormBuilderMode, FormBuilderStateModel, FormConfiguration, FormField, FormRenderMode, FormSection, LocalizedText, MoveFieldPayload, PreviewInfo, PropertyItem, ReorderFieldPayload, ReorderSectionPayload, Response, ToggleValidationPayload, UpdateFieldPayload, UpdateFormSettingsPayload, UpdateSectionPayload, UpdateValidationPayload, ValidationRule, ValidationSeverity };