@gisce/ooui 2.41.0 → 2.43.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gisce/ooui",
-  "version": "2.41.0",
+  "version": "2.43.0-alpha.1",
   "engines": {
     "node": "20.5.0"
   },

package/src/Graph/GraphIndicator.ts

@@ -23,6 +23,16 @@ export class GraphIndicator extends Graph {
     return this._showPercent;
   }
 
+  _progressbar: boolean = false;
+  get progressbar(): boolean {
+    return this._progressbar;
+  }
+
+  _showTotal: boolean = true;
+  get showTotal(): boolean {
+    return this._showTotal;
+  }
+
   _suffix: string | null = null;
   get suffix(): string | null {
     return this._suffix;
@@ -43,5 +53,10 @@ export class GraphIndicator extends Graph {
     this._suffix = element.attributes.suffix || null;
     this._totalDomain = replaceEntities(element.attributes.totalDomain) || null;
     this._showPercent = parseBoolAttribute(element.attributes.showPercent);
+    this._progressbar = parseBoolAttribute(element.attributes.progressbar);
+    this._showTotal =
+      element.attributes.showTotal !== undefined
+        ? parseBoolAttribute(element.attributes.showTotal)
+        : !!this._totalDomain;
   }
 }

package/src/Kanban.ts

@@ -0,0 +1,315 @@
+import WidgetFactory from "./WidgetFactory";
+import Widget from "./Widget";
+import Button from "./Button";
+import { replaceEntities } from "./helpers/attributeParser";
+import { parseBoolAttribute, ParsedNode } from "./helpers/nodeParser";
+import * as txml from "txml";
+import { parseContext } from "./helpers/contextParser";
+import { parseOnChange } from "./helpers/onChangeParser";
+
+export type KanbanField = Widget & {
+  sum?: string; // Aggregation label (e.g., "Total hours")
+};
+
+export type KanbanButton = Button & {
+  states?: string; // Comma-separated states where button should show
+};
+
+class Kanban {
+  /**
+   * Object containing fields specification of the kanban.
+   */
+  _fields: any;
+  get fields() {
+    return this._fields;
+  }
+
+  /**
+   * Array of field widgets to display in cards
+   */
+  _card_fields: KanbanField[] = [];
+  get card_fields(): KanbanField[] {
+    return this._card_fields;
+  }
+
+  /**
+   * Array of button widgets to display in cards
+   */
+  _buttons: KanbanButton[] = [];
+  get buttons(): KanbanButton[] {
+    return this._buttons;
+  }
+
+  _string: string | null = null;
+  get string(): string | null {
+    return this._string;
+  }
+
+  _status: string | null = null;
+  get status(): string | null {
+    return this._status;
+  }
+
+  /**
+   * Widget type
+   */
+  _type: string = "kanban";
+  get type(): string {
+    return this._type;
+  }
+
+  /**
+   * Field that defines the columns (e.g., "state")
+   */
+  _column_field: string = "state";
+  get column_field(): string {
+    return this._column_field;
+  }
+
+  /**
+   * Domain for filtering columns (for many2one fields)
+   * Example: "[('fold', '!=', True)]"
+   */
+  _column_domain: string | null = null;
+  get column_domain(): string | null {
+    return this._column_domain;
+  }
+
+  /**
+   * Enable dragging cards between columns
+   */
+  _drag: boolean = true;
+  get drag(): boolean {
+    return this._drag;
+  }
+
+  /**
+   * Field name to use for sorting cards within columns
+   */
+  _sort: string | undefined = undefined;
+  get sort(): string | undefined {
+    return this._sort;
+  }
+
+  /**
+   * Enable setting max cards per column (WIP limits)
+   */
+  _set_max_cards: boolean = false;
+  get set_max_cards(): boolean {
+    return this._set_max_cards;
+  }
+
+  /**
+   * Color expression value (e.g., "blue:state=='draft';green:state=='done'")
+   */
+  _colors: string | null = null;
+  get colors(): string | null {
+    return this._colors;
+  }
+
+  /**
+   * Custom function to call when a card moves between columns
+   * Example: "handle_state_change" or with args "handle_state_change(field, from, to)"
+   * If not defined, the frontend should use the default on_change_column method
+   */
+  _on_change_column: { method: string; args: string[] } | null = null;
+  get on_change_column(): { method: string; args: string[] } | null {
+    return this._on_change_column;
+  }
+
+  /**
+   * Context for each field in the kanban
+   */
+  _contextForFields: Record<string, any> = {};
+  get contextForFields(): Record<string, any> {
+    return this._contextForFields;
+  }
+
+  set contextForFields(value: Record<string, any>) {
+    this._contextForFields = value;
+  }
+
+  /**
+   * Map of fields that have sum aggregation
+   * Key: field name, Value: sum label (e.g., "Total hours")
+   */
+  _aggregations: Record<string, string> = {};
+  get aggregations(): Record<string, string> {
+    return this._aggregations;
+  }
+
+  constructor(fields: Object) {
+    this._fields = fields;
+  }
+
+  parse(xml: string) {
+    const view = txml
+      .parse(xml)
+      .filter((el: ParsedNode) => el.tagName === "kanban")[0];
+
+    // Parse kanban attributes
+    this._string = view.attributes.string || null;
+    if (this._string) {
+      this._string = replaceEntities(this._string);
+    }
+
+    this._column_field = view.attributes.column_field || "state";
+    this._column_domain = view.attributes.column_domain || null;
+
+    this._drag =
+      view.attributes.drag !== undefined
+        ? parseBoolAttribute(view.attributes.drag)
+        : true;
+    this._sort = view.attributes.sort || undefined;
+    this._set_max_cards =
+      view.attributes.set_max_cards !== undefined
+        ? parseBoolAttribute(view.attributes.set_max_cards)
+        : false;
+
+    this._colors = view.attributes.colors || null;
+    if (this._colors) {
+      this._colors = replaceEntities(this._colors);
+    }
+
+    this._status = view.attributes.status || null;
+    if (this._status) {
+      this._status = replaceEntities(this._status);
+    }
+
+    // Parse on_change_column attribute
+    if (view.attributes.on_change_column) {
+      this._on_change_column = parseOnChange(view.attributes.on_change_column);
+    }
+
+    const widgetFactory = new WidgetFactory();
+
+    // Parse children (fields and buttons)
+    view.children.forEach((element: ParsedNode) => {
+      const { tagName, attributes } = element;
+
+      if (tagName === "field") {
+        this._parseField(element, attributes, widgetFactory);
+      } else if (tagName === "button") {
+        this._parseButton(element, attributes);
+      }
+    });
+  }
+
+  private _parseField(
+    _element: ParsedNode,
+    attributes: any,
+    widgetFactory: WidgetFactory,
+  ) {
+    const { name, widget, sum } = attributes;
+
+    if (!name) {
+      return;
+    }
+
+    if (!this._fields[name]) {
+      throw new Error(`Field ${name} doesn't exist in fields definition`);
+    }
+
+    const fieldDef = this._fields[name];
+    let widgetType = fieldDef.type;
+
+    // Handle domain override
+    if (
+      ((Array.isArray(fieldDef?.domain) && fieldDef?.domain.length === 0) ||
+        fieldDef?.domain === false) &&
+      attributes.domain &&
+      attributes.domain.length > 0
+    ) {
+      delete fieldDef.domain;
+    }
+
+    // Parse context
+    const widgetContext = parseContext({
+      context: attributes.context || fieldDef.context,
+      values: {},
+      fields: this._fields,
+    });
+
+    const mergedAttrs = {
+      ...fieldDef,
+      ...attributes,
+      fieldsWidgetType: fieldDef?.type,
+      context: widgetContext,
+    };
+
+    this._contextForFields[name] = widgetContext;
+
+    // Override widget type if specified
+    if (widget) {
+      widgetType = widget;
+    }
+
+    // Create the widget
+    if (!mergedAttrs.invisible) {
+      const fieldWidget = widgetFactory.createWidget(
+        widgetType,
+        mergedAttrs,
+      ) as KanbanField;
+
+      // Handle aggregation (sum)
+      if (sum) {
+        fieldWidget.sum = replaceEntities(sum);
+        this._aggregations[name] = replaceEntities(sum);
+      }
+
+      this._card_fields.push(fieldWidget);
+    }
+  }
+
+  private _parseButton(_element: ParsedNode, attributes: any) {
+    const { name, type, string, states } = attributes;
+
+    if (!name) {
+      return;
+    }
+
+    const buttonProps = {
+      ...attributes,
+      name,
+      buttonType: type || "object",
+      string: string || "",
+    };
+
+    const button = new Button(buttonProps) as KanbanButton;
+
+    // Parse states attribute (e.g., "draft,open")
+    if (states) {
+      button.states = states;
+    }
+
+    this._buttons.push(button);
+  }
+
+  /**
+   * Find the widgets matching with param id
+   * @param {string} id id to find
+   */
+  findById(id: string): Widget | null {
+    const foundField = this._card_fields.find((item) => {
+      if (item.findById) {
+        return item.findById(id);
+      }
+      return false;
+    });
+
+    if (foundField) {
+      return foundField;
+    }
+
+    const foundButton = this._buttons.find((item) => {
+      if (item.findById) {
+        return item.findById(id);
+      }
+      return false;
+    });
+
+    return foundButton || null;
+  }
+}
+
+export default Kanban;

package/src/KanbanCard.ts

@@ -0,0 +1,84 @@
+import WidgetFactory from "./WidgetFactory";
+import Container from "./Container";
+import Kanban from "./Kanban";
+import { evaluateButtonStates } from "./helpers/stateParser";
+import { evaluateAttributes } from "./helpers/attributeParser";
+import Button from "./Button";
+
+export type KanbanCardParseOptions = {
+  readOnly?: boolean;
+};
+
+class KanbanCard {
+  _kanbanDef: Kanban;
+  get kanbanDef(): Kanban {
+    return this._kanbanDef;
+  }
+
+  constructor(kanbanDef: Kanban) {
+    this._kanbanDef = kanbanDef;
+  }
+
+  parse(record: any, options?: KanbanCardParseOptions): Container {
+    const readOnly = options?.readOnly ?? false;
+    const container = new Container(1, 12, readOnly);
+    const widgetFactory = new WidgetFactory();
+    let keyIdx = 0;
+
+    this._kanbanDef.card_fields.forEach((field: any) => {
+      keyIdx++;
+
+      const evaluatedAttrs = evaluateAttributes({
+        tagAttributes: field.raw_props || {},
+        values: record,
+        fields: this._kanbanDef.fields,
+        widgetType: field.type || "field",
+      });
+
+      // Extract properties from the existing field widget
+      const widgetProps = {
+        ...(field.raw_props || {}),
+        ...evaluatedAttrs,
+        key: `field_${keyIdx}`,
+      };
+
+      if (readOnly) {
+        widgetProps.readonly = true;
+      }
+
+      // Determine widget type from the field
+      const widgetType = field.type || "field";
+      const widget = widgetFactory.createWidget(widgetType, widgetProps);
+      container.addWidget(widget, { addLabel: !field.nolabel });
+    });
+
+    // Add buttons to container
+    this._kanbanDef.buttons.forEach((button: any) => {
+      keyIdx++;
+
+      const evaluatedStates = button.states
+        ? evaluateButtonStates({
+            states: button.states,
+            values: record,
+          })
+        : {};
+
+      const buttonProps = {
+        ...(button.raw_props || {}),
+        ...evaluatedStates,
+        key: `button_${keyIdx}`,
+      };
+
+      if (readOnly) {
+        buttonProps.readonly = true;
+      }
+
+      const buttonWidget = new Button(buttonProps);
+      container.addWidget(buttonWidget, { addLabel: false });
+    });
+
+    return container;
+  }
+}
+
+export default KanbanCard;

package/src/WidgetFactory.ts

@@ -90,6 +90,7 @@ class WidgetFactory {
         this._widgetClass = Selection;
         break;
       case "many2one":
+      case "many2one_lazy":
         this._widgetClass = Many2one;
         break;
       case "boolean":

package/src/helpers/onChangeParser.ts

@@ -3,7 +3,14 @@ const parseOnChange = (onChangeString: string) => {
 
   const method = splitted[0];
   const argsGross = splitted[1];
-  const argsSplitted = argsGross.split(",").map((arg) => arg.trim());
+
+  // Handle case where there are no parentheses (no arguments)
+  const argsSplitted = argsGross
+    ? argsGross
+        .split(",")
+        .map((arg) => arg.trim())
+        .filter((arg) => arg.length > 0)
+    : [];
 
   return {
     method,

package/src/index.ts

@@ -1,6 +1,8 @@
 import Avatar from "./Avatar";
 import Form from "./Form";
 import Tree from "./Tree";
+import Kanban from "./Kanban";
+import KanbanCard from "./KanbanCard";
 import Char from "./Char";
 import Container from "./Container";
 import ContainerWidget from "./ContainerWidget";
@@ -87,6 +89,8 @@ export {
   Widget,
   Form,
   Tree,
+  Kanban,
+  KanbanCard,
   NewLine,
   Boolean,
   One2many,

package/src/spec/Graph.spec.ts

@@ -55,6 +55,66 @@ describe("A Graph", () => {
     expect(graph.field).toBe("potencia");
     expect(graph.operator).toBe("+");
   });
+  it("should parse progressbar, showPercent and showTotal attributes", () => {
+    const xml1 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" progressbar="1" />
+    `;
+
+    const graph1 = parseGraph(xml1) as GraphIndicator;
+    expect(graph1.progressbar).toBe(true);
+    expect(graph1.showPercent).toBe(false);
+    expect(graph1.showTotal).toBe(false); // No totalDomain, should default to false
+
+    const xml2 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" showPercent="1" />
+    `;
+
+    const graph2 = parseGraph(xml2) as GraphIndicator;
+    expect(graph2.showPercent).toBe(true);
+    expect(graph2.progressbar).toBe(false);
+    expect(graph2.showTotal).toBe(false); // No totalDomain, should default to false
+
+    const xml3 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" />
+    `;
+
+    const graph3 = parseGraph(xml3) as GraphIndicator;
+    expect(graph3.showPercent).toBe(false);
+    expect(graph3.progressbar).toBe(false);
+    expect(graph3.showTotal).toBe(false); // No totalDomain, should default to false
+
+    const xml4 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" showTotal="0" />
+    `;
+
+    const graph4 = parseGraph(xml4) as GraphIndicator;
+    expect(graph4.showTotal).toBe(false);
+  });
+  it("should set showTotal to true when totalDomain is defined", () => {
+    const xml1 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" totalDomain="[('state','=','open')]" />
+    `;
+
+    const graph1 = parseGraph(xml1) as GraphIndicator;
+    expect(graph1.totalDomain).toBe("[('state','=','open')]");
+    expect(graph1.showTotal).toBe(true); // totalDomain is defined, should default to true
+
+    const xml2 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" totalDomain="[('state','=','open')]" showTotal="0" />
+    `;
+
+    const graph2 = parseGraph(xml2) as GraphIndicator;
+    expect(graph2.totalDomain).toBe("[('state','=','open')]");
+    expect(graph2.showTotal).toBe(false); // Explicitly set to false
+
+    const xml3 = `<?xml version="1.0"?>
+    <graph string="My indicator" type="indicator" totalDomain="[('state','=','open')]" showTotal="1" />
+    `;
+
+    const graph3 = parseGraph(xml3) as GraphIndicator;
+    expect(graph3.totalDomain).toBe("[('state','=','open')]");
+    expect(graph3.showTotal).toBe(true); // Explicitly set to true
+  });
   it("should parse a graph with timerange parameter", () => {
     const xml = `<?xml version="1.0"?>
     <graph type="line" timerange="day">