@myunisoft/design-system 1.2.6-rev396 → 1.2.7

package/dist/components/DocumentComposer/hooks/useTemporarySection.d.ts

@@ -0,0 +1,31 @@
+import type { RichTreeViewProApiRef } from '@mui/x-tree-view-pro';
+import type { DocumentSection } from '../types';
+export type TemporarySection = Pick<DocumentSection, 'id' | 'parentId'> & {
+    parentVisible: boolean;
+    /** When undefined = editing mode (input), when defined = optimistic mode (waiting for server) */
+    title?: string;
+};
+type UseTemporarySectionParams = {
+    apiRef: RichTreeViewProApiRef;
+    getSectionById: (sectionId: string) => DocumentSection | null;
+    onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
+    scrollToBottom?: () => void;
+};
+/**
+ * Flow:
+ * 1. User triggers `create(parentId)` from context menu
+ * 2. A temporary section appears in the tree in edit mode (title = undefined)
+ * 3. User types a title and presses Enter → `validate()` is called
+ *    - The section transitions to optimistic mode (title = defined)
+ *    - Server creation is called in background
+ * 4. User presses Escape or leaves empty → `cancel()` is called
+ * 5. Server responds → temporary section is cleared, real section replaces it
+ */
+export declare const useTemporarySection: ({ apiRef, getSectionById, onSectionCreate, scrollToBottom }: UseTemporarySectionParams) => {
+    temporarySection: TemporarySection | null;
+    create: (parentId?: string | null) => void;
+    validate: (title: string) => void;
+    cancel: () => void;
+    isTemporary: (sectionId: string) => boolean;
+};
+export {};

package/dist/components/DocumentComposer/hooks/useUnsavedChangesGuard.d.ts

@@ -0,0 +1,19 @@
+type UseUnsavedChangesGuardParams = {
+    isDirty: boolean;
+    selectedSectionId?: string | null;
+    onSectionSelect?: (sectionId: string | null) => void;
+    onSave?: () => Promise<void>;
+    onDirtyReset?: () => void;
+    /** When true, navigate immediately without showing confirmation (discards changes) */
+    skipConfirmation?: boolean;
+};
+export declare const useUnsavedChangesGuard: ({ isDirty, selectedSectionId, onSectionSelect, onSave, onDirtyReset, skipConfirmation }: UseUnsavedChangesGuardParams) => {
+    pendingSectionId: string | null;
+    isModalOpen: boolean;
+    isSaving: boolean;
+    guardedSelect: (sectionId: string | null) => void;
+    saveAndQuit: () => Promise<void>;
+    quitWithoutSaving: () => void;
+    cancelNavigation: () => void;
+};
+export {};

package/dist/components/DocumentComposer/index.d.ts

@@ -0,0 +1,6 @@
+import type { DocumentComposerCallbacks, DocumentComposerCustomProps, DocumentSection } from './types';
+type DocumentComposerProps = {
+    sections?: DocumentSection[];
+} & DocumentComposerCallbacks & DocumentComposerCustomProps;
+declare const DocumentComposer: ({ sections, isLoadingSections, onSectionOrderChange, onSectionTitleChange, onSectionDelete, onSectionVisibilityChange, onSectionCreate, onSectionSelect, onSectionContentSave, noSectionsPlaceholder, getSectionTitleChangePermission, getSectionDeletePermission, getSectionOrderChangePermission, getSectionCreatePermission, getSectionVisibilityChangePermission, hiddenSectionTooltip, visibleIconTooltip, hiddenIconTooltip, renderSectionIcon, isValidDropTarget, sectionContent, isLoadingSectionContent, selectedSectionId, renderDeleteConfirmation, renderUnsavedChangesConfirmation }: DocumentComposerProps) => import("react/jsx-runtime").JSX.Element;
+export default DocumentComposer;

package/dist/components/DocumentComposer/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './props';
+export * from './section';

package/dist/components/DocumentComposer/types/props.d.ts

@@ -0,0 +1,69 @@
+import type { ReactNode } from 'react';
+import type { ItemPositionParams } from '../Treeview/types';
+import type { DocumentSection, SectionContent } from './section';
+export type DeleteConfirmationRenderProps = {
+    isOpen: boolean;
+    onConfirm: () => void;
+    onCancel: () => void;
+};
+export type UnsavedChangesRenderProps = {
+    isOpen: boolean;
+    isSaving: boolean;
+    /** True if onSectionContentSave is provided */
+    canSave: boolean;
+    onSaveAndQuit: () => void;
+    onQuitWithoutSaving: () => void;
+    onCancel: () => void;
+};
+export type DocumentComposerLabels = {
+    createSection?: string;
+    rename?: string;
+    delete?: string;
+    createSubsection?: string;
+    hiddenItemTooltip?: string;
+};
+export type DocumentComposerCustomProps = {
+    noSectionsPlaceholder?: string | ReactNode;
+    isLoadingSections?: boolean;
+    /** Defaults to `() => true` */
+    getSectionTitleChangePermission?: (section: DocumentSection) => boolean;
+    /** Defaults to `() => true` */
+    getSectionDeletePermission?: (section: DocumentSection) => boolean;
+    /** Defaults to `() => true` */
+    getSectionOrderChangePermission?: (section: DocumentSection) => boolean;
+    /** Defaults to `() => true` */
+    getSectionCreatePermission?: (section: DocumentSection) => boolean;
+    /** Defaults to `() => true` */
+    getSectionVisibilityChangePermission?: (section: DocumentSection) => boolean;
+    hiddenSectionTooltip?: string;
+    visibleIconTooltip?: string;
+    hiddenIconTooltip?: string;
+    /** Return null for no icon */
+    renderSectionIcon?: (section: DocumentSection) => ReactNode;
+    /**
+     * Determines valid drop targets during drag. Invalid targets are greyed out.
+     * `targetSection` is `null` when dropping at root level.
+     * `newIndex` is the position where the item would be inserted in the target's children.
+     * `isNesting` is `true` when the section is being moved to a new parent (dropped "on" a section),
+     * `false` when reordering within the same parent.
+     * Defaults to `() => true`.
+     */
+    isValidDropTarget?: (draggedSection: DocumentSection, targetSection: DocumentSection | null, newIndex: number, isNesting: boolean) => boolean;
+    sectionContent?: SectionContent;
+    isLoadingSectionContent?: boolean;
+    selectedSectionId?: string | null;
+    /** If not provided, deletion proceeds without confirmation */
+    renderDeleteConfirmation?: (props: DeleteConfirmationRenderProps) => ReactNode;
+    /** If not provided, navigation proceeds without confirmation (discards changes) */
+    renderUnsavedChangesConfirmation?: (props: UnsavedChangesRenderProps) => ReactNode;
+};
+export type DocumentComposerCallbacks = {
+    onSectionOrderChange?: (params: ItemPositionParams) => void;
+    onSectionTitleChange?: (sectionId: string, newTitle: string) => void;
+    onSectionDelete?: (sectionId: string) => void;
+    onSectionVisibilityChange?: (sectionId: string, visible: boolean) => void;
+    onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
+    onSectionSelect?: (sectionId: string | null) => void;
+    /** Used by unsaved changes modal "Save and quit" action */
+    onSectionContentSave?: () => Promise<void>;
+};

package/dist/components/DocumentComposer/types/section.d.ts

@@ -0,0 +1,33 @@
+export declare const CellFormat: {
+    readonly TEXT: "text";
+    readonly AMOUNT: "amount";
+};
+export type CellFormat = (typeof CellFormat)[keyof typeof CellFormat];
+export type TableCell = {
+    value: string;
+    editable: boolean;
+    format: CellFormat;
+};
+export type TableRow = TableCell[];
+export type TableValue = {
+    id: string;
+    headers: TableRow[];
+    rows: TableRow[];
+    footers: TableRow[];
+};
+export type TableContentBlock = {
+    type: 'table';
+    value: TableValue;
+};
+/** Extend this union as new content block types are added */
+export type ContentBlock = TableContentBlock;
+export type SectionContent = ContentBlock[];
+export type DocumentSection = {
+    id: string;
+    title: string;
+    visible: boolean;
+    parentId: string | null;
+    type?: string;
+    hasTables?: boolean;
+    sections?: DocumentSection[] | null;
+};

package/dist/components/DocumentComposer/types.d.ts

@@ -0,0 +1,56 @@
+import type { ItemPositionParams } from './Treeview/types';
+export type DocumentSection = {
+    id: string;
+    title: string;
+    visible: boolean;
+    parentId: string | null;
+    sections?: DocumentSection[] | null;
+};
+export type DocumentComposerLabels = {
+    /** Label for the "Create section" button */
+    createSection?: string;
+    /** Label for the "Rename" menu item */
+    rename?: string;
+    /** Label for the "Delete" menu item */
+    delete?: string;
+    /** Label for the "Create subsection" menu item */
+    createSubsection?: string;
+    /** Tooltip for hidden item */
+    hiddenItemTooltip?: string;
+};
+export type DocumentComposerCustomProps = {
+    /** Content displayed when there are no sections */
+    noSectionsPlaceholder?: string | React.ReactNode;
+    /** Show a loading state that prevents rendering the sections */
+    isLoading?: boolean;
+    /** Returns whether section title can be edited (double-click + "Renommer" menu). Defaults to `() => true`. */
+    getSectionTitleChangePermission?: (section: DocumentSection) => boolean;
+    /** Returns whether section can be deleted ("Supprimer" menu). Defaults to `() => true`. */
+    getSectionDeletePermission?: (section: DocumentSection) => boolean;
+    /** Returns whether section can be reordered via drag & drop. Defaults to `() => true`. */
+    getSectionOrderChangePermission?: (section: DocumentSection) => boolean;
+    /** Returns whether a section can be created under this section. Defaults to `() => true`. */
+    getSectionCreatePermission?: (section: DocumentSection) => boolean;
+    /** Returns whether section visibility can be toggled. Defaults to `() => true`. */
+    getSectionVisibilityChangePermission?: (section: DocumentSection) => boolean;
+    /** Tooltip text displayed when hovering a hidden section label (visible: false) */
+    hiddenSectionTooltip?: string;
+    /** Tooltip text displayed when hovering the visibility icon of a visible section */
+    visibleIconTooltip?: string;
+    /** Tooltip text displayed when hovering the visibility icon of a hidden section */
+    hiddenIconTooltip?: string;
+    /**
+     * Determines if `targetSection` is a valid drop location for `draggedSection`.
+     * When provided, invalid targets are visually greyed out during drag.
+     * Defaults to () => true (all targets valid).
+     * @param targetSection - The parent section where the item would be dropped, or `null` if dropping at root level.
+     */
+    isValidDropTarget?: (draggedSection: DocumentSection, targetSection: DocumentSection | null) => boolean;
+};
+export type DocumentComposerCallbacks = {
+    onSectionOrderChange?: (params: ItemPositionParams) => void;
+    onSectionTitleChange?: (sectionId: string, newTitle: string) => void;
+    onSectionDelete?: (sectionId: string) => void;
+    onSectionVisibilityChange?: (sectionId: string, visible: boolean) => void;
+    onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
+};

package/dist/components/DocumentComposer/utils/getSectionMenuItems.d.ts

@@ -0,0 +1,14 @@
+import type { ScheduleMenuAction } from '../Treeview/types';
+import type { DocumentSection } from '../types';
+type MenuItemCallbacks = {
+    onRename: (sectionId: string) => void;
+    onDelete: (sectionId: string) => void;
+    onCreateSubsection: (parentId: string) => void;
+};
+type SectionMenuCapabilities = {
+    canRename: boolean;
+    canDelete: boolean;
+    canCreateSubsection: boolean;
+};
+export declare const getSectionMenuItems: (section: DocumentSection, callbacks: MenuItemCallbacks, scheduleMenuAction: ScheduleMenuAction, capabilities: SectionMenuCapabilities) => React.ReactNode[];
+export {};

package/dist/components/DocumentComposer/utils/sectionHelpers.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentSection } from '../types';
+export declare const getAllExpandableSectionIds: (sections: DocumentSection[]) => string[];
+export declare const getAllSectionsFlat: (sections: DocumentSection[]) => DocumentSection[];
+export declare const isRootSection: (section: DocumentSection) => boolean;
+export declare const hasSectionMenu: (_section: DocumentSection) => boolean;
+export declare const isSectionVisible: (section: DocumentSection) => boolean;
+export declare const getSectionChildren: (section: DocumentSection) => DocumentSection[] | undefined;
+export declare const getSectionId: (section: DocumentSection) => string;
+export declare const getSectionTitle: (section: DocumentSection) => string;

package/dist/components/Export/index.d.ts

@@ -0,0 +1,3 @@
+import type { ExportContentProps } from './types';
+declare const ExportContent: ({ exportFormats, onExport, title, selectFormatLabel, exportButtonLabel }: ExportContentProps) => import("react/jsx-runtime").JSX.Element;
+export default ExportContent;

package/dist/components/Export/style/index.d.ts

@@ -0,0 +1,9 @@
+export declare const exportTitleSx: {
+    margin: string;
+    fontFamily: string;
+    fontWeight: number;
+    fontSize: string;
+    lineHeight: number;
+    borderBottom: string;
+    paddingBottom: string;
+};

package/dist/components/Export/types/index.d.ts

@@ -0,0 +1,30 @@
+import { GridExportFormat } from "@mui/x-data-grid-pro";
+/**
+ * Props for ExportContent component
+ */
+export interface ExportContentProps {
+    /**
+     * Available export formats
+     */
+    exportFormats: GridExportFormat[];
+    /**
+     * Handler function called when export is triggered
+     * @param format - Selected export format
+     */
+    onExport: (format: GridExportFormat) => void;
+    /**
+     * Optional title for the export dialog
+     * @default 'Export'
+     */
+    title?: string;
+    /**
+     * Optional label for format selection
+     * @default 'Select format:'
+     */
+    selectFormatLabel?: string;
+    /**
+     * Optional label for the export button
+     * @default 'Export'
+     */
+    exportButtonLabel?: string;
+}