npm - @odoo/o-spreadsheet - Versions diffs - 18.0.55 → 18.0.68 - Mend

@odoo/o-spreadsheet 18.0.55 → 18.0.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (551) hide show

package/dist/types/components/helpers/html_content_helpers.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import { HtmlContent } from "../composer/composer/composer";
2	+ export declare function getHtmlContentFromPattern(pattern: string, value: string, highlightColor: string, className: string): HtmlContent[];

package/dist/types/components/helpers/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export * from "./css";

package/dist/types/components/helpers/listener_hook.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { Ref } from "../../types";
+/**
+ * Manages an event listener on a ref. Useful for hooks that want to manage
+ * event listeners, especially more than one. Prefer using t-on directly in
+ * components. If your hook only needs a single event listener, consider simply
+ * returning it from the hook and letting the user attach it with t-on.
+ *
+ * Adapted from Odoo Community - See https://github.com/odoo/odoo/blob/saas-16.2/addons/web/static/src/core/utils/hooks.js
+ */
+export declare function useRefListener(ref: Ref<HTMLElement>, ...listener: Parameters<typeof addEventListener>): void;
+export declare function useHoveredElement(ref: Ref<HTMLElement>): {
+    hovered: boolean;
+};

package/dist/types/components/helpers/position_hook.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import { useRef } from "@odoo/owl";
+import { Rect } from "../../types";
+type Ref = ReturnType<typeof useRef>;
+/**
+ * Return the o-spreadsheet element position relative
+ * to the browser viewport.
+ */
+export declare function useSpreadsheetRect(): Rect;
+/**
+ * Return the component (or ref's component) BoundingRect, relative
+ * to the upper left corner of the screen (<body> element).
+ *
+ * Note: when used with a <Portal/> component, it will
+ * return the portal position, not the teleported position.
+ */
+export declare function useAbsoluteBoundingRect(ref: Ref): Rect;
+/**
+ * Get the rectangle inside which a popover should stay when being displayed.
+ * It's the value defined in `env.getPopoverContainerRect`, or the Rect of the "o-spreadsheet"
+ * element by default.
+ *
+ * Coordinates are expressed expressed as absolute DOM position.
+ */
+export declare function usePopoverContainer(): Rect;
+export {};

package/dist/types/components/helpers/selection_helpers.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import { SelectionStreamProcessor } from "../../selection_stream/selection_stream_processor";
2	+ export declare function updateSelectionWithArrowKeys(ev: KeyboardEvent, selection: SelectionStreamProcessor): void;

package/dist/types/components/helpers/time_hooks.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+interface IntervalTimer {
+    pause: () => void;
+    resume: () => void;
+}
+interface Timeout {
+    clear: () => void;
+    schedule: (callback: () => void, delay: number) => void;
+}
+/**
+ * Repeatedly calls a callback function with a time delay between calls.
+ */
+export declare function useInterval(callback: () => void, delay: number): IntervalTimer;
+/**
+ * Calls a callback function with a time delay
+ */
+export declare function useTimeOut(): Timeout;
+export {};

package/dist/types/components/helpers/touch_scroll_hook.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { Ref } from "../../types";
+export declare const resetTimeoutDuration = 100;
+export declare function useTouchScroll(ref: Ref<HTMLElement>, updateScroll: (offsetX: number, offsetY: number) => void, canMoveUp: () => boolean): void;

package/dist/types/components/helpers/wheel_hook.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function useWheelHandler(handler: (deltaX: number, deltaY: number) => void): (ev: WheelEvent) => void;

package/dist/types/components/highlight/border/border.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import { Component } from "@odoo/owl";
+import { Pixel, SpreadsheetChildEnv, Zone } from "../../../types";
+type Orientation = "n" | "s" | "w" | "e";
+interface Props {
+    zone: Zone;
+    orientation: Orientation;
+    isMoving: boolean;
+    onMoveHighlight: (x: Pixel, y: Pixel) => void;
+}
+export declare class Border extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        zone: ObjectConstructor;
+        orientation: StringConstructor;
+        isMoving: BooleanConstructor;
+        onMoveHighlight: FunctionConstructor;
+    };
+    get style(): string;
+    onMouseDown(ev: MouseEvent): void;
+}
+export {};

package/dist/types/components/highlight/corner/corner.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import { Component } from "@odoo/owl";
+import { Color, SpreadsheetChildEnv, Zone } from "../../../types";
+type Orientation = "nw" | "ne" | "sw" | "se";
+interface Props {
+    zone: Zone;
+    color: Color;
+    orientation: Orientation;
+    isResizing: boolean;
+    onResizeHighlight: (isLeft: boolean, isRight: boolean) => void;
+}
+export declare class Corner extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        zone: ObjectConstructor;
+        color: StringConstructor;
+        orientation: StringConstructor;
+        isResizing: BooleanConstructor;
+        onResizeHighlight: FunctionConstructor;
+    };
+    private isTop;
+    private isLeft;
+    get style(): string;
+    onMouseDown(ev: MouseEvent): void;
+}
+export {};

package/dist/types/components/highlight/highlight/highlight.d.ts ADDED Viewed

@@ -0,0 +1,26 @@
+import { Component } from "@odoo/owl";
+import { Color, Pixel, SpreadsheetChildEnv, Zone } from "../../../types";
+import { Border } from "../border/border";
+import { Corner } from "../corner/corner";
+interface Props {
+    zone: Zone;
+    color: Color;
+}
+interface HighlightState {
+    shiftingMode: "isMoving" | "isResizing" | "none";
+}
+export declare class Highlight extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        zone: ObjectConstructor;
+        color: StringConstructor;
+    };
+    static components: {
+        Corner: typeof Corner;
+        Border: typeof Border;
+    };
+    highlightState: HighlightState;
+    onResizeHighlight(isLeft: boolean, isTop: boolean): void;
+    onMoveHighlight(clientX: Pixel, clientY: Pixel): void;
+}
+export {};

package/dist/types/components/icon_picker/icon_picker.d.ts ADDED Viewed

@@ -0,0 +1,68 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../types/env";
+interface Props {
+    onIconPicked: (icon: string) => void;
+}
+export declare class IconPicker extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        onIconPicked: FunctionConstructor;
+    };
+    icons: {
+        arrowGood: {
+            template: string;
+            img: string;
+        };
+        arrowNeutral: {
+            template: string;
+            img: string;
+        };
+        arrowBad: {
+            template: string;
+            img: string;
+        };
+        smileyGood: {
+            template: string;
+            img: string;
+        };
+        smileyNeutral: {
+            template: string;
+            img: string;
+        };
+        smileyBad: {
+            template: string;
+            img: string;
+        };
+        dotGood: {
+            template: string;
+            img: string;
+        };
+        dotNeutral: {
+            template: string;
+            img: string;
+        };
+        dotBad: {
+            template: string;
+            img: string;
+        };
+    };
+    iconSets: {
+        arrows: {
+            good: string;
+            neutral: string;
+            bad: string;
+        };
+        smiley: {
+            good: string;
+            neutral: string;
+            bad: string;
+        };
+        dots: {
+            good: string;
+            neutral: string;
+            bad: string;
+        };
+    };
+    onIconClick(icon: string): void;
+}
+export {};

package/dist/types/components/icons/icons.d.ts ADDED Viewed

@@ -0,0 +1,56 @@
+export type IconSetType = keyof typeof ICON_SETS;
+export declare const ICONS: {
+    arrowGood: {
+        template: string;
+        img: string;
+    };
+    arrowNeutral: {
+        template: string;
+        img: string;
+    };
+    arrowBad: {
+        template: string;
+        img: string;
+    };
+    smileyGood: {
+        template: string;
+        img: string;
+    };
+    smileyNeutral: {
+        template: string;
+        img: string;
+    };
+    smileyBad: {
+        template: string;
+        img: string;
+    };
+    dotGood: {
+        template: string;
+        img: string;
+    };
+    dotNeutral: {
+        template: string;
+        img: string;
+    };
+    dotBad: {
+        template: string;
+        img: string;
+    };
+};
+export declare const ICON_SETS: {
+    arrows: {
+        good: string;
+        neutral: string;
+        bad: string;
+    };
+    smiley: {
+        good: string;
+        neutral: string;
+        bad: string;
+    };
+    dots: {
+        good: string;
+        neutral: string;
+        bad: string;
+    };
+};

package/dist/types/components/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { Spreadsheet } from "./spreadsheet/spreadsheet";

package/dist/types/components/link/index.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export * from "./link_display/link_display";
2	+ export * from "./link_editor/link_editor";

package/dist/types/components/link/link_display/link_display.d.ts ADDED Viewed

@@ -0,0 +1,28 @@
+import { Component } from "@odoo/owl";
+import { Store } from "../../../store_engine";
+import { EvaluatedCell, Link, Position, SpreadsheetChildEnv } from "../../../types";
+import { PopoverBuilders } from "../../../types/cell_popovers";
+import { CellPopoverStore } from "../../popover/cell_popover_store";
+interface LinkDisplayProps {
+    cellPosition: Position;
+}
+export declare class LinkDisplay extends Component<LinkDisplayProps, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        cellPosition: ObjectConstructor;
+        onClosed: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+    };
+    protected cellPopovers: Store<CellPopoverStore>;
+    setup(): void;
+    get cell(): EvaluatedCell;
+    get link(): Link;
+    getUrlRepresentation(link: Link): string;
+    openLink(): void;
+    edit(): void;
+    unlink(): void;
+}
+export declare const LinkCellPopoverBuilder: PopoverBuilders;
+export {};

package/dist/types/components/link/link_editor/link_editor.d.ts ADDED Viewed

@@ -0,0 +1,46 @@
+import { Component } from "@odoo/owl";
+import { DOMCoordinates, Link, Position, SpreadsheetChildEnv } from "../../../types";
+import { PopoverBuilders } from "../../../types/cell_popovers";
+import { Menu } from "../../menu/menu";
+interface LinkEditorProps {
+    cellPosition: Position;
+    onClosed?: () => void;
+}
+interface State {
+    label: string;
+    url: string;
+    isUrlEditable: boolean;
+}
+export declare class LinkEditor extends Component<LinkEditorProps, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        cellPosition: ObjectConstructor;
+        onClosed: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+    };
+    static components: {
+        Menu: typeof Menu;
+    };
+    menuItems: import("../../../actions/action").Action[];
+    private link;
+    private menu;
+    private linkEditorRef;
+    private position;
+    urlInput: {
+        el: HTMLElement | null;
+    };
+    setup(): void;
+    get defaultState(): State;
+    get menuPosition(): DOMCoordinates;
+    onSpecialLink(ev: CustomEvent<string>): void;
+    getUrlRepresentation(link: Link): string;
+    openMenu(): void;
+    removeLink(): void;
+    save(): void;
+    cancel(): void;
+    onKeyDown(ev: KeyboardEvent): void;
+}
+export declare const LinkEditorPopoverBuilder: PopoverBuilders;
+export {};

package/dist/types/components/menu/menu.d.ts ADDED Viewed

@@ -0,0 +1,99 @@
+import { Component } from "@odoo/owl";
+import { Action } from "../../actions/action";
+import { DOMCoordinates, Pixel, SpreadsheetChildEnv, UID } from "../../types";
+import { Popover, PopoverProps } from "../popover/popover";
+type MenuItemOrSeparator = Action | "separator";
+interface Props {
+    position: DOMCoordinates;
+    menuItems: Action[];
+    depth: number;
+    maxHeight?: Pixel;
+    onClose: () => void;
+    onMenuClicked?: (ev: CustomEvent) => void;
+    menuId?: UID;
+    onMouseOver?: () => void;
+    width?: number;
+}
+export interface MenuState {
+    isOpen: boolean;
+    parentMenu?: Action;
+    position: null | DOMCoordinates;
+    scrollOffset?: Pixel;
+    menuItems: Action[];
+    isHoveringChild?: boolean;
+}
+export declare class Menu extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        position: ObjectConstructor;
+        menuItems: ArrayConstructor;
+        depth: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        maxHeight: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+        onClose: FunctionConstructor;
+        onMenuClicked: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        menuId: {
+            type: StringConstructor;
+            optional: boolean;
+        };
+        onMouseOver: {
+            type: FunctionConstructor;
+            optional: boolean;
+        };
+        width: {
+            type: NumberConstructor;
+            optional: boolean;
+        };
+    };
+    static components: {
+        Menu: typeof Menu;
+        Popover: typeof Popover;
+    };
+    static defaultProps: {
+        depth: number;
+    };
+    private subMenu;
+    private menuRef;
+    private hoveredMenu;
+    private position;
+    private openingTimeOut;
+    setup(): void;
+    get menuItemsAndSeparators(): MenuItemOrSeparator[];
+    get subMenuPosition(): DOMCoordinates;
+    get popoverProps(): PopoverProps;
+    get childrenHaveIcon(): boolean;
+    getIconName(menu: Action): string;
+    getColor(menu: Action): string;
+    getIconColor(menu: Action): string;
+    activateMenu(menu: Action): Promise<void>;
+    private close;
+    private onExternalClick;
+    getName(menu: Action): string;
+    isRoot(menu: Action): boolean;
+    isEnabled(menu: Action): boolean;
+    isActive(menuItem: Action): boolean;
+    onScroll(ev: any): void;
+    /**
+     * If the given menu is not disabled, open it's submenu at the
+     * correct position according to available surrounding space.
+     */
+    private openSubMenu;
+    isParentMenu(subMenu: MenuState, menuItem: Action): boolean;
+    private closeSubMenu;
+    onClickMenu(menu: Action, ev: MouseEvent): void;
+    onMouseOver(menu: Action, ev: MouseEvent): void;
+    onMouseOverMainMenu(): void;
+    onMouseOverChildMenu(): void;
+    onMouseEnter(menu: Action, ev: MouseEvent): void;
+    onMouseLeave(menu: Action): void;
+    get menuStyle(): string;
+}
+export {};

package/dist/types/components/paint_format_button/paint_format_button.d.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv } from "../../types";
+interface Props {
+    class?: string;
+}
+export declare class PaintFormatButton extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static props: {
+        class: {
+            type: StringConstructor;
+            optional: boolean;
+        };
+    };
+    private paintFormatStore;
+    setup(): void;
+    get isActive(): boolean;
+    onDblClick(): void;
+    togglePaintFormat(): void;
+}
+export {};

package/dist/types/components/paint_format_button/paint_format_store.d.ts ADDED Viewed

@@ -0,0 +1,27 @@
+import { Get } from "../../store_engine";
+import { SpreadsheetStore } from "../../stores";
+import { Command, Highlight, Zone } from "../../types";
+export declare class PaintFormatStore extends SpreadsheetStore {
+    mutators: readonly ["activate", "cancel", "pasteFormat"];
+    protected highlightStore: {
+        readonly register: (highlightProvider: import("../../stores/highlight_store").HighlightProvider) => void;
+        readonly unRegister: (highlightProvider: import("../../stores/highlight_store").HighlightProvider) => void;
+        readonly mutators: readonly ["register", "unRegister"];
+        readonly renderingLayers: readonly ["Highlights"];
+        readonly highlights: Highlight[];
+    };
+    private status;
+    private copiedData?;
+    constructor(get: Get);
+    protected handle(cmd: Command): void;
+    activate(args: {
+        persistent: boolean;
+    }): void;
+    cancel(): void;
+    pasteFormat(target: Zone[]): void;
+    get isActive(): boolean;
+    private get clipboardHandlers();
+    private copyFormats;
+    private paintFormat;
+    get highlights(): Highlight[];
+}

package/dist/types/components/pivot_html_renderer/pivot_html_renderer.d.ts ADDED Viewed

@@ -0,0 +1,87 @@
+import { Component } from "@odoo/owl";
+import { SpreadsheetChildEnv, SpreadsheetPivotTable, UID } from "../..";
+import { Checkbox } from "../side_panel/components/checkbox/checkbox";
+interface PivotDialogColumn {
+    formula: string;
+    value: string;
+    isMissing: boolean;
+    style?: string;
+    span: number;
+}
+interface PivotDialogRow {
+    formula: string;
+    value: string;
+    isMissing: boolean;
+    style?: string;
+}
+interface PivotDialogValue {
+    formula: string;
+    value: string;
+    isMissing: boolean;
+}
+interface Props {
+    pivotId: UID;
+    onCellClicked: (formula: string) => void;
+}
+interface TableData {
+    columns: PivotDialogColumn[][];
+    rows: PivotDialogRow[];
+    values: PivotDialogValue[][];
+}
+export declare class PivotHTMLRenderer extends Component<Props, SpreadsheetChildEnv> {
+    static template: string;
+    static components: {
+        Checkbox: typeof Checkbox;
+    };
+    static props: {
+        pivotId: StringConstructor;
+        onCellClicked: FunctionConstructor;
+    };
+    private pivot;
+    data: TableData;
+    private state;
+    setup(): void;
+    get tracker(): import("../../helpers/pivot/pivot_presence_tracker").PivotPresenceTracker | undefined;
+    /**
+     * Retrieve the data to display in the Pivot Table
+     * In the case when showMissingValuesOnly is false, the returned value
+     * is the complete data
+     * In the case when showMissingValuesOnly is true, the returned value is
+     * the data which contains only missing values in the rows and cols. In
+     * the rows, we also return the parent rows of rows which contains missing
+     * values, to give context to the user.
+     *
+     */
+    getTableData(): TableData;
+    /**
+     * Retrieve the parents of the given row
+     * ex:
+     *  Australia
+     *    January
+     *    February
+     * The parent of "January" is "Australia"
+     */
+    private addRecursiveRow;
+    /**
+     * Create the columns to be used, based on the indexes of the columns in
+     * which a missing value is present
+     *
+     */
+    private buildColumnsMissing;
+    /**
+     * Create the rows to be used, based on the indexes of the rows in
+     * which a missing value is present.
+     */
+    private buildRowsMissing;
+    /**
+     * Create the value to be used, based on the indexes of the columns and
+     * rows in which a missing value is present.
+     */
+    private buildValuesMissing;
+    private getColumnsIndexes;
+    private getRowsIndexes;
+    _buildColHeaders(id: UID, table: SpreadsheetPivotTable): PivotDialogColumn[][];
+    _buildRowHeaders(id: UID, table: SpreadsheetPivotTable): PivotDialogRow[];
+    _buildValues(id: UID, table: SpreadsheetPivotTable): PivotDialogValue[][];
+}
+export {};

package/dist/types/components/popover/cell_popover_store.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { SpreadsheetStore } from "../../stores";
+import { Command, Position } from "../../types";
+import { CellPopoverType, ClosedCellPopover, OpenCellPopover, PositionedCellPopoverComponent } from "../../types/cell_popovers";
+export declare class CellPopoverStore extends SpreadsheetStore {
+    mutators: readonly ["open", "close"];
+    private persistentPopover?;
+    protected hoveredCell: {
+        readonly clear: () => void;
+        readonly hover: (position: Position) => void;
+        readonly mutators: readonly ["clear", "hover"];
+        readonly col: number | undefined;
+        readonly row: number | undefined;
+        readonly renderingLayers: Readonly<import("../..").LayerName[]>;
+    };
+    handle(cmd: Command): void;
+    open({ col, row }: Position, type: CellPopoverType): void;
+    close(): "noStateChange" | undefined;
+    get persistentCellPopover(): OpenCellPopover | ClosedCellPopover;
+    get isOpen(): boolean;
+    get cellPopover(): ClosedCellPopover | PositionedCellPopoverComponent;
+    private computePopoverAnchorRect;
+}

package/dist/types/components/popover/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import "./popover_builders";
+export * from "./cell_popover_store";
+export * from "./popover";