@odoo/o-spreadsheet 17.1.2 → 17.1.4

package/dist/o-spreadsheet.d.ts

@@ -33,8 +33,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[];
 
@@ -1179,7 +1179,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.
@@ -1430,6 +1430,7 @@ interface UIPluginConfig {
     readonly uiActions: UIActions;
     readonly custom: ModelConfig["custom"];
     readonly session: Session;
+    readonly defaultCurrencyFormat?: Format;
 }
 interface UIPluginConstructor {
     new (config: UIPluginConfig): UIPlugin;
@@ -3006,6 +3007,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;
@@ -3027,6 +3034,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
     startCellEdition: (content?: string) => void;
     loadCurrencies?: () => Promise<Currency[]>;
     loadLocales: () => Promise<Locale[]>;
+    focusableElement: FocusableElement;
 }
 
 declare class RangeAdapter implements CommandHandler<CoreCommand> {
@@ -3070,8 +3078,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;
@@ -7804,11 +7816,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;
@@ -7833,7 +7846,6 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
         focus: {
             validate: (value: string) => boolean;
         };
-        onComposerContentFocused: FunctionConstructor;
         inputStyle: {
             type: StringConstructor;
             optional: boolean;
@@ -7846,10 +7858,15 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
             type: ObjectConstructor;
             optional: boolean;
         };
-        onComposerUnmounted: {
+        onComposerCellFocused: {
             type: FunctionConstructor;
             optional: boolean;
         };
+        onComposerContentFocused: FunctionConstructor;
+        isDefaultFocus: {
+            type: BooleanConstructor;
+            optional: boolean;
+        };
     };
     static components: {
         TextValueProvider: typeof TextValueProvider;
@@ -7857,6 +7874,7 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     };
     static defaultProps: {
         inputStyle: string;
+        isDefaultFocus: boolean;
     };
     composerRef: {
         el: HTMLElement | null;
@@ -7879,7 +7897,6 @@ declare class Composer extends Component<ComposerProps, SpreadsheetChildEnv> {
     private processArrowKeys;
     private handleArrowKeysForAutocomplete;
     private processTabKey;
-    processSpaceKey(ev: KeyboardEvent): void;
     private processEnterKey;
     private processNewLineEvent;
     private processEscapeKey;
@@ -7888,6 +7905,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;
@@ -8096,7 +8114,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.
@@ -8110,8 +8128,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;
 }
 /**
@@ -8124,24 +8142,30 @@ declare class GridComposer extends Component<Props$5, SpreadsheetChildEnv> {
         focus: {
             validate: (value: string) => boolean;
         };
-        onComposerUnmounted: FunctionConstructor;
+        onComposerCellFocused: FunctionConstructor;
         onComposerContentFocused: FunctionConstructor;
         gridDims: ObjectConstructor;
     };
     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 {
@@ -8377,7 +8401,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>;
@@ -8389,7 +8412,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;
@@ -8409,7 +8432,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;