@odoo/o-spreadsheet 1.0.1

package/src/registries/menus/cell_menu_registry.ts

@@ -0,0 +1,79 @@
+import { _lt } from "../../translation";
+import { SpreadsheetEnv } from "../../types";
+import { MenuItemRegistry } from "../menu_items_registry";
+import * as ACTIONS from "./menu_items_actions";
+
+//------------------------------------------------------------------------------
+// Context Menu Registry
+//------------------------------------------------------------------------------
+
+export const cellMenuRegistry = new MenuItemRegistry();
+
+cellMenuRegistry
+  .add("cut", {
+    name: _lt("Cut"),
+    sequence: 10,
+    action: ACTIONS.CUT_ACTION,
+  })
+  .add("copy", {
+    name: _lt("Copy"),
+    sequence: 20,
+    action: ACTIONS.COPY_ACTION,
+  })
+  .add("paste", {
+    name: _lt("Paste"),
+    sequence: 30,
+    action: ACTIONS.PASTE_ACTION,
+  })
+  .add("paste_special", {
+    name: _lt("Paste special"),
+    sequence: 40,
+    separator: true,
+  })
+  .addChild("paste_value_only", ["paste_special"], {
+    name: _lt("Paste values only"),
+    sequence: 10,
+    action: ACTIONS.PASTE_VALUE_ACTION,
+  })
+  .addChild("paste_format_only", ["paste_special"], {
+    name: _lt("Paste format only"),
+    sequence: 20,
+    action: ACTIONS.PASTE_FORMAT_ACTION,
+  })
+  .add("add_row_before", {
+    name: ACTIONS.CELL_INSERT_ROWS_BEFORE_NAME,
+    sequence: 50,
+    action: ACTIONS.INSERT_ROWS_BEFORE_ACTION,
+  })
+  .add("add_column_before", {
+    name: ACTIONS.CELL_INSERT_COLUMNS_BEFORE_NAME,
+    sequence: 70,
+    action: ACTIONS.INSERT_COLUMNS_BEFORE_ACTION,
+    separator: true,
+  })
+  .add("delete_row", {
+    name: ACTIONS.REMOVE_ROWS_NAME,
+    sequence: 90,
+    action: ACTIONS.REMOVE_ROWS_ACTION,
+  })
+  .add("delete_column", {
+    name: ACTIONS.REMOVE_COLUMNS_NAME,
+    sequence: 100,
+    action: ACTIONS.REMOVE_COLUMNS_ACTION,
+    separator: true,
+  })
+  .add("clear_cell", {
+    name: _lt("Clear cell"),
+    sequence: 110,
+    action: ACTIONS.DELETE_CONTENT_ACTION,
+    isEnabled: (env: SpreadsheetEnv) => {
+      const cell = env.getters.getActiveCell();
+      return Boolean(cell && cell.content);
+    },
+  })
+  .add("conditional_formatting", {
+    name: _lt("Conditional formatting"),
+    sequence: 120,
+    action: ACTIONS.OPEN_CF_SIDEPANEL_ACTION,
+    separator: true,
+  });

package/src/registries/menus/col_menu_registry.ts

@@ -0,0 +1,63 @@
+import { _lt } from "../../translation";
+import { MenuItemRegistry } from "../menu_items_registry";
+import * as ACTIONS from "./menu_items_actions";
+
+export const colMenuRegistry = new MenuItemRegistry();
+
+colMenuRegistry
+  .add("cut", {
+    name: _lt("Cut"),
+    sequence: 10,
+    action: ACTIONS.CUT_ACTION,
+  })
+  .add("copy", {
+    name: _lt("Copy"),
+    sequence: 20,
+    action: ACTIONS.COPY_ACTION,
+  })
+  .add("paste", {
+    name: _lt("Paste"),
+    sequence: 30,
+    action: ACTIONS.PASTE_ACTION,
+  })
+  .add("paste_special", {
+    name: _lt("Paste special"),
+    sequence: 40,
+    separator: true,
+  })
+  .addChild("paste_value_only", ["paste_special"], {
+    name: _lt("Paste value only"),
+    sequence: 10,
+    action: ACTIONS.PASTE_VALUE_ACTION,
+  })
+  .addChild("paste_format_only", ["paste_special"], {
+    name: _lt("Paste format only"),
+    sequence: 20,
+    action: ACTIONS.PASTE_FORMAT_ACTION,
+  })
+  .add("add_column_before", {
+    name: ACTIONS.COLUMN_INSERT_COLUMNS_BEFORE_NAME,
+    sequence: 50,
+    action: ACTIONS.INSERT_COLUMNS_BEFORE_ACTION,
+  })
+  .add("add_column_after", {
+    name: ACTIONS.COLUMN_INSERT_COLUMNS_AFTER_NAME,
+    sequence: 60,
+    action: ACTIONS.INSERT_COLUMNS_AFTER_ACTION,
+  })
+  .add("delete_column", {
+    name: ACTIONS.REMOVE_COLUMNS_NAME,
+    sequence: 70,
+    action: ACTIONS.REMOVE_COLUMNS_ACTION,
+  })
+  .add("clear_column", {
+    name: ACTIONS.DELETE_CONTENT_COLUMNS_NAME,
+    sequence: 80,
+    action: ACTIONS.DELETE_CONTENT_COLUMNS_ACTION,
+    separator: true,
+  })
+  .add("conditional_formatting", {
+    name: _lt("Conditional formatting"),
+    sequence: 90,
+    action: ACTIONS.OPEN_CF_SIDEPANEL_ACTION,
+  });

package/src/registries/menus/index.ts

@@ -0,0 +1,6 @@
+export * from "./cell_menu_registry";
+export * from "./col_menu_registry";
+export * from "./menu_items_actions";
+export * from "./row_menu_registry";
+export * from "./sheet_menu_registry";
+export * from "./topbar_menu_registry";

package/src/registries/menus/menu_items_actions.ts

@@ -0,0 +1,425 @@
+import { numberToLetters, uuidv4 } from "../../helpers/index";
+import { _lt } from "../../translation";
+import { SpreadsheetEnv, Style } from "../../types/index";
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+function getColumnsNumber(env: SpreadsheetEnv): number {
+  const activeCols = env.getters.getActiveCols();
+  if (activeCols.size) {
+    return activeCols.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    return zone.right - zone.left + 1;
+  }
+}
+
+function getRowsNumber(env: SpreadsheetEnv): number {
+  const activeRows = env.getters.getActiveRows();
+  if (activeRows.size) {
+    return activeRows.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    return zone.bottom - zone.top + 1;
+  }
+}
+
+export function setFormatter(env: SpreadsheetEnv, formatter: string) {
+  env.dispatch("SET_FORMATTER", {
+    sheet: env.getters.getActiveSheet(),
+    target: env.getters.getSelectedZones(),
+    formatter,
+  });
+}
+
+export function setStyle(env: SpreadsheetEnv, style: Style) {
+  env.dispatch("SET_FORMATTING", {
+    sheet: env.getters.getActiveSheet(),
+    target: env.getters.getSelectedZones(),
+    style,
+  });
+}
+
+//------------------------------------------------------------------------------
+// Simple actions
+//------------------------------------------------------------------------------
+
+export const UNDO_ACTION = (env: SpreadsheetEnv) => env.dispatch("UNDO");
+
+export const REDO_ACTION = (env: SpreadsheetEnv) => env.dispatch("REDO");
+
+export const COPY_ACTION = async (env: SpreadsheetEnv) => {
+  env.dispatch("COPY", { target: env.getters.getSelectedZones() });
+  await env.clipboard.writeText(env.getters.getClipboardContent());
+};
+
+export const CUT_ACTION = async (env: SpreadsheetEnv) => {
+  env.dispatch("CUT", { target: env.getters.getSelectedZones() });
+  await env.clipboard.writeText(env.getters.getClipboardContent());
+};
+
+export const PASTE_ACTION = async (env: SpreadsheetEnv) => {
+  const spreadsheetClipboard = env.getters.getClipboardContent();
+  let osClipboard;
+  try {
+    osClipboard = await env.clipboard.readText();
+  } catch (e) {
+    // Permission is required to read the clipboard.
+    console.warn("The OS clipboard could not be read.");
+    console.error(e);
+  }
+  const target = env.getters.getSelectedZones();
+  if (osClipboard && osClipboard !== spreadsheetClipboard) {
+    env.dispatch("PASTE_FROM_OS_CLIPBOARD", {
+      target,
+      text: osClipboard,
+    });
+  } else {
+    env.dispatch("PASTE", { target, interactive: true });
+  }
+};
+
+export const PASTE_VALUE_ACTION = (env: SpreadsheetEnv) =>
+  env.dispatch("PASTE", { target: env.getters.getSelectedZones(), onlyValue: true });
+
+export const PASTE_FORMAT_ACTION = (env: SpreadsheetEnv) =>
+  env.dispatch("PASTE", { target: env.getters.getSelectedZones(), onlyFormat: true });
+
+export const DELETE_CONTENT_ACTION = (env: SpreadsheetEnv) =>
+  env.dispatch("DELETE_CONTENT", {
+    sheet: env.getters.getActiveSheet(),
+    target: env.getters.getSelectedZones(),
+  });
+
+export const SET_FORMULA_VISIBILITY_ACTION = (env: SpreadsheetEnv) =>
+  env.dispatch("SET_FORMULA_VISIBILITY", { show: !env.getters.shouldShowFormulas() });
+
+//------------------------------------------------------------------------------
+// Grid manipulations
+//------------------------------------------------------------------------------
+
+export const DELETE_CONTENT_ROWS_NAME = (env: SpreadsheetEnv) => {
+  let first: number;
+  let last: number;
+  const activesRows = env.getters.getActiveRows();
+  if (activesRows.size !== 0) {
+    first = Math.min(...activesRows);
+    last = Math.max(...activesRows);
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    first = zone.top;
+    last = zone.bottom;
+  }
+  if (first === last) {
+    return _lt("Clear row %s", (first + 1).toString());
+  }
+  return _lt("Clear rows %s - %s", (first + 1).toString(), (last + 1).toString());
+};
+
+export const DELETE_CONTENT_ROWS_ACTION = (env: SpreadsheetEnv) => {
+  const target = [...env.getters.getActiveRows()].map((index) =>
+    env.getters.getRowsZone(index, index)
+  );
+  env.dispatch("DELETE_CONTENT", {
+    target,
+    sheet: env.getters.getActiveSheet(),
+  });
+};
+
+export const DELETE_CONTENT_COLUMNS_NAME = (env: SpreadsheetEnv) => {
+  let first: number;
+  let last: number;
+  const activeCols = env.getters.getActiveCols();
+  if (activeCols.size !== 0) {
+    first = Math.min(...activeCols);
+    last = Math.max(...activeCols);
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    first = zone.left;
+    last = zone.right;
+  }
+  if (first === last) {
+    return _lt("Clear column %s", numberToLetters(first));
+  }
+  return _lt("Clear columns %s - %s", numberToLetters(first), numberToLetters(last));
+};
+
+export const DELETE_CONTENT_COLUMNS_ACTION = (env: SpreadsheetEnv) => {
+  const target = [...env.getters.getActiveCols()].map((index) =>
+    env.getters.getColsZone(index, index)
+  );
+  env.dispatch("DELETE_CONTENT", {
+    target,
+    sheet: env.getters.getActiveSheet(),
+  });
+};
+
+export const REMOVE_ROWS_NAME = (env: SpreadsheetEnv) => {
+  let first: number;
+  let last: number;
+  const activesRows = env.getters.getActiveRows();
+  if (activesRows.size !== 0) {
+    first = Math.min(...activesRows);
+    last = Math.max(...activesRows);
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    first = zone.top;
+    last = zone.bottom;
+  }
+  if (first === last) {
+    return _lt("Delete row %s", (first + 1).toString());
+  }
+  return _lt("Delete rows %s - %s", (first + 1).toString(), (last + 1).toString());
+};
+
+export const REMOVE_ROWS_ACTION = (env: SpreadsheetEnv) => {
+  let rows = [...env.getters.getActiveRows()];
+  if (!rows.length) {
+    const zone = env.getters.getSelectedZones()[0];
+    for (let i = zone.top; i <= zone.bottom; i++) {
+      rows.push(i);
+    }
+  }
+  env.dispatch("REMOVE_ROWS", {
+    sheet: env.getters.getActiveSheet(),
+    rows,
+  });
+};
+
+export const REMOVE_COLUMNS_NAME = (env: SpreadsheetEnv) => {
+  let first: number;
+  let last: number;
+  const activeCols = env.getters.getActiveCols();
+  if (activeCols.size !== 0) {
+    first = Math.min(...activeCols);
+    last = Math.max(...activeCols);
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    first = zone.left;
+    last = zone.right;
+  }
+  if (first === last) {
+    return _lt("Delete column %s", numberToLetters(first));
+  }
+  return _lt("Delete columns %s - %s", numberToLetters(first), numberToLetters(last));
+};
+
+export const REMOVE_COLUMNS_ACTION = (env: SpreadsheetEnv) => {
+  let columns = [...env.getters.getActiveCols()];
+  if (!columns.length) {
+    const zone = env.getters.getSelectedZones()[0];
+    for (let i = zone.left; i <= zone.right; i++) {
+      columns.push(i);
+    }
+  }
+  env.dispatch("REMOVE_COLUMNS", {
+    sheet: env.getters.getActiveSheet(),
+    columns,
+  });
+};
+
+export const MENU_INSERT_ROWS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getRowsNumber(env);
+  if (number === 1) {
+    return _lt("Row above");
+  }
+  return _lt("%s Rows above", number.toString());
+};
+
+export const ROW_INSERT_ROWS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getRowsNumber(env);
+  return number === 1 ? _lt("Insert row above") : _lt("Insert %s rows above", number.toString());
+};
+
+export const CELL_INSERT_ROWS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getRowsNumber(env);
+  if (number === 1) {
+    return _lt("Insert row");
+  }
+  return _lt("Insert %s rows", number.toString());
+};
+
+export const INSERT_ROWS_BEFORE_ACTION = (env: SpreadsheetEnv) => {
+  const activeRows = env.getters.getActiveRows();
+  let row: number;
+  let quantity: number;
+  if (activeRows.size) {
+    row = Math.min(...activeRows);
+    quantity = activeRows.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    row = zone.top;
+    quantity = zone.bottom - zone.top + 1;
+  }
+  env.dispatch("ADD_ROWS", {
+    sheet: env.getters.getActiveSheet(),
+    position: "before",
+    row,
+    quantity,
+  });
+};
+
+export const MENU_INSERT_ROWS_AFTER_NAME = (env: SpreadsheetEnv) => {
+  const number = getRowsNumber(env);
+  if (number === 1) {
+    return _lt("Row below");
+  }
+  return _lt("%s Rows below", number.toString());
+};
+
+export const ROW_INSERT_ROWS_AFTER_NAME = (env: SpreadsheetEnv) => {
+  const number = getRowsNumber(env);
+  return number === 1 ? _lt("Insert row below") : _lt("Insert %s rows below", number.toString());
+};
+
+export const INSERT_ROWS_AFTER_ACTION = (env: SpreadsheetEnv) => {
+  const activeRows = env.getters.getActiveRows();
+  let row: number;
+  let quantity: number;
+  if (activeRows.size) {
+    row = Math.max(...activeRows);
+    quantity = activeRows.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    row = zone.bottom;
+    quantity = zone.bottom - zone.top + 1;
+  }
+  env.dispatch("ADD_ROWS", {
+    sheet: env.getters.getActiveSheet(),
+    position: "after",
+    row,
+    quantity,
+  });
+};
+
+export const MENU_INSERT_COLUMNS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getColumnsNumber(env);
+  if (number === 1) {
+    return _lt("Column left");
+  }
+  return _lt("%s Columns left", number.toString());
+};
+
+export const COLUMN_INSERT_COLUMNS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getColumnsNumber(env);
+  return number === 1
+    ? _lt("Insert column left")
+    : _lt("Insert %s columns left", number.toString());
+};
+
+export const CELL_INSERT_COLUMNS_BEFORE_NAME = (env: SpreadsheetEnv) => {
+  const number = getColumnsNumber(env);
+  if (number === 1) {
+    return _lt("Insert column");
+  }
+  return _lt("Insert %s columns", number.toString());
+};
+
+export const INSERT_COLUMNS_BEFORE_ACTION = (env: SpreadsheetEnv) => {
+  const activeCols = env.getters.getActiveCols();
+  let column: number;
+  let quantity: number;
+  if (activeCols.size) {
+    column = Math.min(...activeCols);
+    quantity = activeCols.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    column = zone.left;
+    quantity = zone.right - zone.left + 1;
+  }
+  env.dispatch("ADD_COLUMNS", {
+    sheet: env.getters.getActiveSheet(),
+    position: "before",
+    column,
+    quantity,
+  });
+};
+
+export const MENU_INSERT_COLUMNS_AFTER_NAME = (env: SpreadsheetEnv) => {
+  const number = getColumnsNumber(env);
+  if (number === 1) {
+    return _lt("Column right");
+  }
+  return _lt("%s Columns right", number.toString());
+};
+
+export const COLUMN_INSERT_COLUMNS_AFTER_NAME = (env: SpreadsheetEnv) => {
+  const number = getColumnsNumber(env);
+  return number === 1
+    ? _lt("Insert column right")
+    : _lt("Insert %s columns right", number.toString());
+};
+
+export const INSERT_COLUMNS_AFTER_ACTION = (env: SpreadsheetEnv) => {
+  const activeCols = env.getters.getActiveCols();
+  let column: number;
+  let quantity: number;
+  if (activeCols.size) {
+    column = Math.max(...activeCols);
+    quantity = activeCols.size;
+  } else {
+    const zone = env.getters.getSelectedZones()[0];
+    column = zone.right;
+    quantity = zone.right - zone.left + 1;
+  }
+  env.dispatch("ADD_COLUMNS", {
+    sheet: env.getters.getActiveSheet(),
+    position: "after",
+    column,
+    quantity,
+  });
+};
+
+//------------------------------------------------------------------------------
+// Sheets
+//------------------------------------------------------------------------------
+
+export const CREATE_SHEET_ACTION = (env: SpreadsheetEnv) => {
+  env.dispatch("CREATE_SHEET", { activate: true, id: uuidv4() });
+};
+
+//------------------------------------------------------------------------------
+// Charts
+//------------------------------------------------------------------------------
+
+export const CREATE_CHART = (env: SpreadsheetEnv) => {
+  env.openSidePanel("ChartPanel");
+};
+
+//------------------------------------------------------------------------------
+// Style/Format
+//------------------------------------------------------------------------------
+
+export const FORMAT_AUTO_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "");
+
+export const FORMAT_NUMBER_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "#,##0.00");
+
+export const FORMAT_PERCENT_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "0.00%");
+
+export const FORMAT_DATE_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "m/d/yyyy");
+
+export const FORMAT_TIME_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "hh:mm:ss a");
+
+export const FORMAT_DATE_TIME_ACTION = (env: SpreadsheetEnv) =>
+  setFormatter(env, "m/d/yyyy hh:mm:ss");
+
+export const FORMAT_DURATION_ACTION = (env: SpreadsheetEnv) => setFormatter(env, "hhhh:mm:ss");
+
+export const FORMAT_BOLD_ACTION = (env: SpreadsheetEnv) =>
+  setStyle(env, { bold: !env.getters.getCurrentStyle().bold });
+
+export const FORMAT_ITALIC_ACTION = (env: SpreadsheetEnv) =>
+  setStyle(env, { italic: !env.getters.getCurrentStyle().italic });
+
+export const FORMAT_STRIKETHROUGH_ACTION = (env: SpreadsheetEnv) =>
+  setStyle(env, { strikethrough: !env.getters.getCurrentStyle().strikethrough });
+
+//------------------------------------------------------------------------------
+// Side panel
+//------------------------------------------------------------------------------
+
+export const OPEN_CF_SIDEPANEL_ACTION = (env: SpreadsheetEnv) => {
+  env.openSidePanel("ConditionalFormatting", { selection: env.getters.getSelectedZones() });
+};

package/src/registries/menus/row_menu_registry.ts

@@ -0,0 +1,63 @@
+import { _lt } from "../../translation";
+import { MenuItemRegistry } from "../menu_items_registry";
+import * as ACTIONS from "./menu_items_actions";
+
+export const rowMenuRegistry = new MenuItemRegistry();
+
+rowMenuRegistry
+  .add("cut", {
+    name: _lt("Cut"),
+    sequence: 10,
+    action: ACTIONS.CUT_ACTION,
+  })
+  .add("copy", {
+    name: _lt("Copy"),
+    sequence: 20,
+    action: ACTIONS.COPY_ACTION,
+  })
+  .add("paste", {
+    name: _lt("Paste"),
+    sequence: 30,
+    action: ACTIONS.PASTE_ACTION,
+  })
+  .add("paste_special", {
+    name: _lt("Paste special"),
+    sequence: 40,
+    separator: true,
+  })
+  .addChild("paste_value_only", ["paste_special"], {
+    name: _lt("Paste value only"),
+    sequence: 10,
+    action: ACTIONS.PASTE_VALUE_ACTION,
+  })
+  .addChild("paste_format_only", ["paste_special"], {
+    name: _lt("Paste format only"),
+    sequence: 20,
+    action: ACTIONS.PASTE_FORMAT_ACTION,
+  })
+  .add("add_row_before", {
+    name: ACTIONS.ROW_INSERT_ROWS_BEFORE_NAME,
+    sequence: 50,
+    action: ACTIONS.INSERT_ROWS_BEFORE_ACTION,
+  })
+  .add("add_row_after", {
+    name: ACTIONS.ROW_INSERT_ROWS_AFTER_NAME,
+    sequence: 60,
+    action: ACTIONS.INSERT_ROWS_AFTER_ACTION,
+  })
+  .add("delete_row", {
+    name: ACTIONS.REMOVE_ROWS_NAME,
+    sequence: 70,
+    action: ACTIONS.REMOVE_ROWS_ACTION,
+  })
+  .add("clear_row", {
+    name: ACTIONS.DELETE_CONTENT_ROWS_NAME,
+    sequence: 80,
+    action: ACTIONS.DELETE_CONTENT_ROWS_ACTION,
+    separator: true,
+  })
+  .add("conditional_formatting", {
+    name: _lt("Conditional formatting"),
+    sequence: 90,
+    action: ACTIONS.OPEN_CF_SIDEPANEL_ACTION,
+  });