@masterteam/form-builder 0.0.2 → 0.0.3

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

@@ -0,0 +1,297 @@
+import * as _masterteam_form_builder from '@masterteam/form-builder';
+import * as _angular_core from '@angular/core';
+import { LoadingStateShape, CrudStateBase, Response as Response$1 } from '@masterteam/components';
+import { CdkDragDrop } from '@angular/cdk/drag-drop';
+import * as rxjs from 'rxjs';
+import { StateContext } from '@ngxs/store';
+
+declare enum FormBuilderActionKey {
+    GetFormConfiguration = "getFormConfiguration",
+    ResetFormConfiguration = "resetFormConfiguration",
+    AddSection = "addSection",
+    UpdateSection = "updateSection",
+    DeleteSection = "deleteSection",
+    AddField = "addField",
+    UpdateField = "updateField",
+    DeleteField = "deleteField",
+    MoveField = "moveField",
+    ReorderFields = "reorderFields"
+}
+type FieldWidth = '25' | '50' | '100';
+interface FormField {
+    id: string;
+    sectionId: string;
+    propertyId: number;
+    width: FieldWidth;
+    order: number;
+    hiddenInCreation?: boolean;
+    hiddenInEditForm?: boolean;
+    isRequired?: boolean;
+    showConditionalDisplayFormula?: boolean;
+    conditionalDisplayFormula?: string;
+    _pending?: boolean;
+    _deleting?: boolean;
+}
+interface FormSection {
+    id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    order: number;
+    fields: FormField[];
+}
+interface FormConfiguration {
+    isActive: boolean;
+    sections: FormSection[];
+}
+interface AddSectionPayload {
+    name: {
+        en: string;
+        ar: string;
+    };
+    order?: number;
+}
+interface UpdateSectionPayload {
+    name?: {
+        en: string;
+        ar: string;
+    };
+    order?: number;
+}
+interface AddFieldPayload {
+    propertyId: number;
+    width: FieldWidth;
+    order?: number;
+    hiddenInCreation?: boolean;
+    hiddenInEditForm?: boolean;
+    isRequired?: boolean;
+    showConditionalDisplayFormula?: boolean;
+    conditionalDisplayFormula?: string;
+}
+interface UpdateFieldPayload {
+    width?: FieldWidth;
+    order?: number;
+    hiddenInCreation?: boolean;
+    hiddenInEditForm?: boolean;
+    isRequired?: boolean;
+    showConditionalDisplayFormula?: boolean;
+    conditionalDisplayFormula?: string | null;
+}
+interface MoveFieldPayload {
+    targetSectionId: string;
+    order?: number;
+}
+interface ReorderFieldPayload {
+    id: string;
+    order: number;
+}
+interface PropertyItem {
+    id: number;
+    name: string | Record<string, string>;
+    viewType?: string;
+    [key: string]: any;
+}
+interface EnrichedFormField extends FormField {
+    name: string;
+    type: string;
+    data?: any;
+}
+interface EnrichedFormSection extends Omit<FormSection, 'fields'> {
+    fields: EnrichedFormField[];
+}
+interface FormBuilderStateModel extends LoadingStateShape<FormBuilderActionKey> {
+    moduleType: string | null;
+    moduleId: string | number | null;
+    parentModuleType: string | null;
+    parentModuleId: string | number | null;
+    parentPath: string;
+    formConfiguration: FormConfiguration | null;
+    properties: PropertyItem[];
+}
+
+declare class FormBuilderFacade {
+    private readonly store;
+    private readonly stateSignal;
+    readonly formConfiguration: _angular_core.Signal<_masterteam_form_builder.FormConfiguration | null>;
+    readonly sections: _angular_core.Signal<_masterteam_form_builder.FormSection[]>;
+    readonly properties: _angular_core.Signal<PropertyItem[]>;
+    readonly moduleType: _angular_core.Signal<string | null>;
+    readonly moduleId: _angular_core.Signal<string | number | null>;
+    readonly isLoadingFormConfiguration: _angular_core.Signal<boolean>;
+    readonly isResettingFormConfiguration: _angular_core.Signal<boolean>;
+    readonly isAddingSection: _angular_core.Signal<boolean>;
+    readonly isUpdatingSection: _angular_core.Signal<boolean>;
+    readonly isDeletingSection: _angular_core.Signal<boolean>;
+    readonly isAddingField: _angular_core.Signal<boolean>;
+    readonly isUpdatingField: _angular_core.Signal<boolean>;
+    readonly isDeletingField: _angular_core.Signal<boolean>;
+    readonly isMovingField: _angular_core.Signal<boolean>;
+    readonly formConfigurationError: _angular_core.Signal<string | null>;
+    readonly sectionError: _angular_core.Signal<string | null>;
+    readonly fieldError: _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>;
+    setProperties(properties: PropertyItem[]): rxjs.Observable<void>;
+    getFormConfiguration(): rxjs.Observable<void>;
+    resetFormConfiguration(): rxjs.Observable<void>;
+    addSection(payload: AddSectionPayload): rxjs.Observable<void>;
+    updateSection(sectionId: string, payload: UpdateSectionPayload): rxjs.Observable<void>;
+    deleteSection(sectionId: string): rxjs.Observable<void>;
+    addField(sectionId: string, payload: AddFieldPayload): rxjs.Observable<void>;
+    updateField(sectionId: string, fieldId: string, payload: UpdateFieldPayload): rxjs.Observable<void>;
+    deleteField(sectionId: string, fieldId: string): rxjs.Observable<void>;
+    reorderFields(sectionId: string, payload: ReorderFieldPayload[]): rxjs.Observable<void>;
+    moveField(sectionId: string, fieldId: string, payload: MoveFieldPayload): rxjs.Observable<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderFacade, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<FormBuilderFacade>;
+}
+
+declare class FormBuilder {
+    private readonly modalService;
+    private readonly confirmationService;
+    private readonly translocoService;
+    protected readonly facade: FormBuilderFacade;
+    private dialogRef;
+    readonly activeTab: _angular_core.WritableSignal<string>;
+    readonly sections: _angular_core.Signal<_masterteam_form_builder.FormSection[]>;
+    readonly properties: _angular_core.Signal<PropertyItem[]>;
+    readonly isLoading: _angular_core.Signal<boolean>;
+    readonly error: _angular_core.Signal<string | null>;
+    private readonly propertiesMap;
+    readonly enrichedSections: _angular_core.Signal<EnrichedFormSection[]>;
+    readonly availableTabs: _angular_core.Signal<{
+        id: string;
+        title: string;
+        properties: PropertyItem[];
+    }[]>;
+    constructor();
+    drop(event: CdkDragDrop<EnrichedFormField[] | PropertyItem[]>): void;
+    addSection(): void;
+    openPreview(): void;
+    resetFormConfiguration(): void;
+    noReturnPredicate: () => boolean;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilder, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormBuilder, "mt-form-builder", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Standard API Response wrapper
+ */
+interface Response<T> {
+    endpoint: string;
+    status: number;
+    code: number;
+    locale: string;
+    message?: string | null;
+    errors?: any | null;
+    data: T;
+    cacheSession?: string;
+}
+
+declare class SetModuleInfo {
+    moduleType: string;
+    moduleId: string | number;
+    parentModuleType?: string | undefined;
+    parentModuleId?: string | number | undefined;
+    parentPath?: string | undefined;
+    static readonly type = "[FormBuilder] Set Module Info";
+    constructor(moduleType: string, moduleId: string | number, parentModuleType?: string | undefined, parentModuleId?: string | number | undefined, parentPath?: string | undefined);
+}
+declare class ResetFormBuilderState {
+    static readonly type = "[FormBuilder] Reset State";
+}
+declare class SetProperties {
+    properties: PropertyItem[];
+    static readonly type = "[FormBuilder] Set Properties";
+    constructor(properties: PropertyItem[]);
+}
+declare class GetFormConfiguration {
+    static readonly type = "[FormBuilder] Get Form Configuration";
+}
+declare class ResetFormConfiguration {
+    static readonly type = "[FormBuilder] Reset Form Configuration";
+}
+declare class AddSection {
+    payload: AddSectionPayload;
+    static readonly type = "[FormBuilder] Add Section";
+    constructor(payload: AddSectionPayload);
+}
+declare class UpdateSection {
+    sectionId: string;
+    payload: UpdateSectionPayload;
+    static readonly type = "[FormBuilder] Update Section";
+    constructor(sectionId: string, payload: UpdateSectionPayload);
+}
+declare class DeleteSection {
+    sectionId: string;
+    static readonly type = "[FormBuilder] Delete Section";
+    constructor(sectionId: string);
+}
+declare class AddField {
+    sectionId: string;
+    payload: AddFieldPayload;
+    static readonly type = "[FormBuilder] Add Field";
+    constructor(sectionId: string, payload: AddFieldPayload);
+}
+declare class UpdateField {
+    sectionId: string;
+    fieldId: string;
+    payload: UpdateFieldPayload;
+    static readonly type = "[FormBuilder] Update Field";
+    constructor(sectionId: string, fieldId: string, payload: UpdateFieldPayload);
+}
+declare class DeleteField {
+    sectionId: string;
+    fieldId: string;
+    static readonly type = "[FormBuilder] Delete Field";
+    constructor(sectionId: string, fieldId: string);
+}
+declare class ReorderFields {
+    sectionId: string;
+    payload: ReorderFieldPayload[];
+    static readonly type = "[FormBuilder] Reorder Fields";
+    constructor(sectionId: string, payload: ReorderFieldPayload[]);
+}
+declare class MoveField {
+    sectionId: string;
+    fieldId: string;
+    payload: MoveFieldPayload;
+    static readonly type = "[FormBuilder] Move Field";
+    constructor(sectionId: string, fieldId: string, payload: MoveFieldPayload);
+}
+
+declare class FormBuilderState extends CrudStateBase<FormSection, FormBuilderStateModel, FormBuilderActionKey> {
+    private http;
+    private baseUrl;
+    private getApiPath;
+    static getState(state: FormBuilderStateModel): FormBuilderStateModel;
+    static getFormConfiguration(state: FormBuilderStateModel): FormConfiguration | null;
+    static getSections(state: FormBuilderStateModel): FormSection[];
+    static getModuleType(state: FormBuilderStateModel): string | null;
+    static getModuleId(state: FormBuilderStateModel): string | number | null;
+    static getProperties(state: FormBuilderStateModel): _masterteam_form_builder.PropertyItem[];
+    setModuleInfo(ctx: StateContext<FormBuilderStateModel>, action: SetModuleInfo): void;
+    resetState(ctx: StateContext<FormBuilderStateModel>): void;
+    setProperties(ctx: StateContext<FormBuilderStateModel>, action: SetProperties): void;
+    getFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>>;
+    resetFormConfiguration(ctx: StateContext<FormBuilderStateModel>): rxjs.Observable<Response$1<FormConfiguration>>;
+    addSection(ctx: StateContext<FormBuilderStateModel>, action: AddSection): rxjs.Observable<Response$1<FormSection>>;
+    updateSection(ctx: StateContext<FormBuilderStateModel>, action: UpdateSection): rxjs.Observable<Response$1<FormSection>>;
+    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<{
+        id: string;
+        sectionId: string;
+    }>>;
+    reorderFields(ctx: StateContext<FormBuilderStateModel>, action: ReorderFields): rxjs.Observable<Response$1<FormField[]>>;
+    moveField(ctx: StateContext<FormBuilderStateModel>, action: MoveField): rxjs.Observable<Response$1<FormField>>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderState, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<FormBuilderState>;
+}
+
+export { AddField, AddSection, DeleteField, DeleteSection, FormBuilder, FormBuilderActionKey, FormBuilderFacade, FormBuilderState, GetFormConfiguration, MoveField, ReorderFields, ResetFormBuilderState, ResetFormConfiguration, SetModuleInfo, SetProperties, UpdateField, UpdateSection };
+export type { AddFieldPayload, AddSectionPayload, EnrichedFormField, EnrichedFormSection, FieldWidth, FormBuilderStateModel, FormConfiguration, FormField, FormSection, MoveFieldPayload, PropertyItem, ReorderFieldPayload, Response, UpdateFieldPayload, UpdateSectionPayload };