@odoo/o-spreadsheet 17.0.9 → 17.0.12

package/dist/o-spreadsheet.d.ts

@@ -44,8 +44,8 @@ interface EnrichedToken extends Token {
 
 type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "SYMBOL" | "SPACE" | "DEBUGGER" | "ARG_SEPARATOR" | "LEFT_PAREN" | "RIGHT_PAREN" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
 interface Token {
-    type: TokenType;
-    value: string;
+    readonly type: TokenType;
+    readonly value: string;
 }
 declare function tokenize(str: string, locale?: Locale): Token[];
 
@@ -1190,7 +1190,7 @@ interface ModelConfig {
     readonly custom: Readonly<{
         [key: string]: any;
     }>;
-    readonly defaultCurrencyFormat: Format;
+    readonly defaultCurrencyFormat?: Format;
     /**
      * External dependencies required to enable some features
      * such as uploading images.
@@ -1441,6 +1441,7 @@ interface UIPluginConfig {
     readonly uiActions: UIActions;
     readonly custom: ModelConfig["custom"];
     readonly session: Session;
+    readonly defaultCurrencyFormat?: Format;
 }
 interface UIPluginConstructor {
     new (config: UIPluginConfig): UIPlugin;
@@ -3089,6 +3090,12 @@ interface ClipboardInterface {
     readText(): Promise<ClipboardReadResult>;
 }
 
+declare class FocusableElement {
+    private focusableElement;
+    setFocusableElement(element: HTMLElement): void;
+    focus(): void;
+}
+
 type NotificationType = "danger" | "info" | "success" | "warning";
 interface InformationNotification {
     text: string;
@@ -3110,6 +3117,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     startCellEdition: (content?: string) => void;
     loadCurrencies?: () => Promise<Currency[]>;
     loadLocales: () => Promise<Locale[]>;
+    focusableElement: FocusableElement;
 }
 
 type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "RANGE<ANY>" | "META";
@@ -3197,8 +3205,12 @@ declare class RangeAdapter implements CommandHandler<CoreCommand> {
      *
      * @param range the range (received from getRangeFromXC or getRangeFromZone)
      * @param forSheetId the id of the sheet where the range string is supposed to be used.
+     * @param options
+     * @param options.useFixedReference if true, the range will be returned with fixed row and column
      */
-    getRangeString(range: Range, forSheetId: UID): string;
+    getRangeString(range: Range, forSheetId: UID, options?: {
+        useFixedReference: boolean;
+    }): string;
     getRangeDataFromXc(sheetId: UID, xc: string): RangeData;
     getRangeDataFromZone(sheetId: UID, zone: Zone | UnboundedZone): RangeData;
     getRangeFromZone(sheetId: UID, zone: Zone | UnboundedZone): Range;
@@ -3418,7 +3430,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
      * starting an async evaluation even if it has been moved or re-allocated
      */
     getCellById(cellId: UID): Cell | undefined;
-    getFormulaCellContent(sheetId: UID, compiledFormula: RangeCompiledFormula, dependencies?: Range[]): string;
+    getFormulaCellContent(sheetId: UID, compiledFormula: RangeCompiledFormula, dependencies?: Range[], useFixedReference?: boolean): string;
     getTranslatedCellFormula(sheetId: UID, offsetX: number, offsetY: number, compiledFormula: RangeCompiledFormula): string;
     getCellStyle(position: CellPosition): Style;
     /**
@@ -3464,6 +3476,7 @@ declare class CellPlugin extends CorePlugin<CoreState> implements CoreState {
     private createErrorFormula;
     private checkCellOutOfSheet;
     private checkUselessClearCell;
+    private checkUselessUpdateCell;
 }
 
 /**
@@ -7088,6 +7101,8 @@ interface Props$b {
 }
 declare class TextValueProvider extends Component<Props$b> {
     static template: string;
+    private autoCompleteListRef;
+    setup(): void;
 }
 
 declare class ContentEditableHelper {
@@ -7178,11 +7193,12 @@ interface AutocompleteValue {
 }
 interface ComposerProps {
     focus: ComposerFocusType;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
     inputStyle?: string;
     rect?: Rect;
     delimitation?: DOMDimension;
-    onComposerUnmounted?: () => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused?: (content: String) => void;
+    isDefaultFocus?: boolean;
 }
 interface ComposerState$1 {
     positionStart: number;
@@ -7209,6 +7225,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     };
     static defaultProps: {
         inputStyle: string;
+        isDefaultFocus: boolean;
     };
     composerRef: {
         el: HTMLElement | null;
@@ -7231,7 +7248,6 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     private processArrowKeys;
     private handleArrowKeysForAutocomplete;
     private processTabKey;
-    processSpaceKey(ev: KeyboardEvent): void;
     private processEnterKey;
     private processEscapeKey;
     private processF4Key;
@@ -7239,6 +7255,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     onCompositionStart(): void;
     onCompositionEnd(): void;
     onKeydown(ev: KeyboardEvent): void;
+    onPaste(ev: ClipboardEvent): void;
     onInput(ev: InputEvent): void;
     onKeyup(ev: KeyboardEvent): void;
     showFunctionAutocomplete(searchTerm: string): void;
@@ -7418,7 +7435,7 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
     focusGrid(): void;
     onKeydown(ev: KeyboardEvent): void;
     onTopBarComposerFocused(selection: ComposerSelection): void;
-    onGridComposerContentFocused(): void;
+    onGridComposerContentFocused(selection: ComposerSelection): void;
     onGridComposerCellFocused(content?: string, selection?: ComposerSelection): void;
     /**
      * Start the edition or update the content if it's already started.
@@ -7432,8 +7449,8 @@ declare class Spreadsheet extends Component<SpreadsheetProps, SpreadsheetChildEn
 
 interface Props$5 {
     focus: ComposerFocusType;
-    onComposerUnmounted: () => void;
-    onComposerContentFocused: (selection: ComposerSelection) => void;
+    onComposerContentFocused: () => void;
+    onComposerCellFocused: () => void;
     gridDims: DOMDimension;
 }
 /**
@@ -7445,17 +7462,23 @@ declare class GridComposer extends Component<Props$5, SpreadsheetChildEnv> {
     static components: {
         Composer: typeof Composer;
     };
-    private gridComposerRef;
-    private zone;
     private rect;
+    private isEditing;
     private isCellReferenceVisible;
-    private composerState;
+    get defaultRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     setup(): void;
     get shouldDisplayCellReference(): boolean;
     get cellReference(): string;
     get cellReferenceStyle(): string;
+    get composerProps(): ComposerProps;
     get containerStyle(): string;
-    get composerStyle(): string;
+    private updateComponentPosition;
+    private updateCellReferenceVisibility;
 }
 
 interface ResizerState {
@@ -7655,7 +7678,6 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     readonly HEADER_WIDTH = 48;
     private menuState;
     private gridRef;
-    private hiddenInput;
     onMouseWheel: (ev: WheelEvent) => void;
     canvasPosition: DOMCoordinates;
     hoveredCell: Partial<Position$1>;
@@ -7667,7 +7689,7 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     get gridOverlayDimensions(): string;
     onClosePopover(): void;
     private keyDownMapping;
-    focus(): void;
+    focusDefaultElement(): void;
     get gridEl(): HTMLElement;
     getAutofillPosition(): {
         left: number;
@@ -7687,7 +7709,6 @@ declare class Grid extends Component<Props$1, SpreadsheetChildEnv> {
     closeOpenedPopover(): void;
     processArrows(ev: KeyboardEvent): void;
     onKeydown(ev: KeyboardEvent): void;
-    onInput(ev: InputEvent): void;
     onInputContextMenu(ev: MouseEvent): void;
     onCellRightClicked(col: HeaderIndex, row: HeaderIndex, { x, y }: DOMCoordinates): void;
     toggleContextMenu(type: ContextMenuType, x: Pixel, y: Pixel): void;