@gisce/ooui 2.38.0 → 2.40.0-alpha.1

package/package.json

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

package/src/Card.ts

@@ -0,0 +1,52 @@
+import Spinner from "./Spinner";
+
+class Card extends Spinner {
+  _title: string | null = null;
+  get title(): string | null {
+    return this._title;
+  }
+
+  set title(value: string | null) {
+    this._title = value;
+  }
+
+  _icon: string | null = null;
+  get icon(): string | null {
+    return this._icon;
+  }
+
+  set icon(value: string | null) {
+    this._icon = value;
+  }
+
+  /**
+   * Height of the card component
+   */
+  _height: number | undefined = undefined;
+
+  get height(): number | undefined {
+    return this._height;
+  }
+
+  set height(value: number | undefined) {
+    this._height = value;
+  }
+
+  constructor(props: any) {
+    super(props);
+    if (props) {
+      if (props.title) {
+        this._title = props.title;
+      }
+      if (props.icon) {
+        this._icon = props.icon;
+      }
+      if (props.height) {
+        const parsedHeight = parseInt(props.height);
+        this._height = isNaN(parsedHeight) ? undefined : parsedHeight;
+      }
+    }
+  }
+}
+
+export default Card;

package/src/Kanban.ts

@@ -0,0 +1,285 @@
+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";
+
+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;
+  }
+
+  /**
+   * Widget type
+   */
+  _type: string = "kanban";
+  get type(): string {
+    return this._type;
+  }
+
+  /**
+   * Field that defines the columns (e.g., "state")
+   */
+  _column_field: string | null = null;
+  get column_field(): string | null {
+    return this._column_field;
+  }
+
+  /**
+   * Enable dragging cards between columns
+   */
+  _drag: boolean = true;
+  get drag(): boolean {
+    return this._drag;
+  }
+
+  /**
+   * Enable sorting cards within columns
+   */
+  _sort: boolean = true;
+  get sort(): boolean {
+    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;
+  }
+
+  /**
+   * 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 || null;
+    if (!this._column_field) {
+      throw new Error("Kanban view must have a column_field attribute");
+    }
+
+    this._drag =
+      view.attributes.drag !== undefined
+        ? parseBoolAttribute(view.attributes.drag)
+        : true;
+    this._sort =
+      view.attributes.sort !== undefined
+        ? parseBoolAttribute(view.attributes.sort)
+        : true;
+    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);
+    }
+
+    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/WidgetFactory.ts

@@ -45,6 +45,7 @@ import Spinner from "./Spinner";
 import Carousel from "./Carousel";
 import ColorPicker from "./ColorPicker";
 import QRCode from "./QRCode";
+import Card from "./Card";
 
 class WidgetFactory {
   /**
@@ -63,6 +64,9 @@ class WidgetFactory {
       case "group":
         this._widgetClass = Group;
         break;
+      case "card":
+        this._widgetClass = Card;
+        break;
       case "label":
         this._widgetClass = Label;
         break;
@@ -227,6 +231,7 @@ class WidgetFactory {
       case "notebook":
       case "page":
       case "group":
+      case "card":
         return new this._widgetClass({ ...props, type: finalType });
       case "button":
         return new this._widgetClass({

package/src/index.ts

@@ -1,6 +1,7 @@
 import Avatar from "./Avatar";
 import Form from "./Form";
 import Tree from "./Tree";
+import Kanban from "./Kanban";
 import Char from "./Char";
 import Container from "./Container";
 import ContainerWidget from "./ContainerWidget";
@@ -57,6 +58,7 @@ import Spinner from "./Spinner";
 import Carousel from "./Carousel";
 import ColorPicker from "./ColorPicker";
 import QRCode from "./QRCode";
+import Card from "./Card";
 
 import {
   Graph,
@@ -85,6 +87,7 @@ export {
   Widget,
   Form,
   Tree,
+  Kanban,
   NewLine,
   Boolean,
   One2many,
@@ -150,4 +153,5 @@ export {
   Carousel,
   ColorPicker,
   QRCode,
+  Card,
 };

package/src/spec/Card.spec.ts

@@ -0,0 +1,89 @@
+import Card from "../Card";
+import WidgetImpl from "./fixtures/WidgetImpl";
+import WidgetFactory from "../WidgetFactory";
+import { it, expect, describe } from "vitest";
+
+describe("A Card", () => {
+  it("should be constructed with 4 columns and a colspan of 4", () => {
+    const card4 = new Card({ col: 4, colspan: 4 });
+    expect(card4.colspan).toBe(4);
+    expect(card4.container.columns).toBe(4);
+  });
+  it("should be constructed with 6 columns and a colspan of 2", () => {
+    const card4 = new Card({ col: 6, colspan: 2 });
+    expect(card4.colspan).toBe(2);
+    expect(card4.container.columns).toBe(6);
+  });
+  it("should have 1 rows if 4 items", () => {
+    const card4 = new Card({ col: 4, colspan: 4 });
+    card4.container.addWidget(new WidgetImpl({ name: "1" }));
+    card4.container.addWidget(new WidgetImpl({ name: "2" }));
+    card4.container.addWidget(new WidgetImpl({ name: "3" }));
+    card4.container.addWidget(new WidgetImpl({ name: "4" }));
+    expect(card4.container.rows.length).toBe(1);
+  });
+  it("should have 2 rows if 5 items", () => {
+    const card4 = new Card({ col: 4, colspan: 4 });
+    card4.container.addWidget(new WidgetImpl({ name: "1" }));
+    card4.container.addWidget(new WidgetImpl({ name: "2" }));
+    card4.container.addWidget(new WidgetImpl({ name: "3" }));
+    card4.container.addWidget(new WidgetImpl({ name: "4" }));
+    card4.container.addWidget(new WidgetImpl({ name: "5" }));
+    expect(card4.container.rows.length).toBe(2);
+  });
+  it("can have an icon property", () => {
+    const widgetFactory = new WidgetFactory();
+    const props = {
+      title: "General",
+      icon: "home",
+    };
+    const widget = widgetFactory.createWidget("card", props);
+    expect(widget.icon).toEqual("home");
+  });
+  it("can have a title property", () => {
+    const widgetFactory = new WidgetFactory();
+    const props = {
+      title: "Card Title",
+      icon: "user",
+    };
+    const widget = widgetFactory.createWidget("card", props);
+    expect(widget.title).toEqual("Card Title");
+  });
+  it("can have a height property", () => {
+    const widgetFactory = new WidgetFactory();
+    const props = {
+      title: "Card Title",
+      height: "200",
+    };
+    const widget = widgetFactory.createWidget("card", props);
+    expect(widget.height).toEqual(200);
+  });
+  it("should handle invalid height values", () => {
+    const widgetFactory = new WidgetFactory();
+    const props = {
+      title: "Card Title",
+      height: "invalid",
+    };
+    const widget = widgetFactory.createWidget("card", props);
+    expect(widget.height).toBeUndefined();
+  });
+  describe("working as a spinner", () => {
+    it("should be loading false as default", () => {
+      const widgetFactory = new WidgetFactory();
+      const props = {
+        title: "A card",
+      };
+      const widget = widgetFactory.createWidget("card", props);
+      expect(widget.loading).toBe(false);
+    });
+    it("should be loading true if set", () => {
+      const widgetFactory = new WidgetFactory();
+      const props = {
+        title: "A card",
+        loading: true,
+      };
+      const widget = widgetFactory.createWidget("card", props);
+      expect(widget.loading).toBe(true);
+    });
+  });
+});