feat!: Use the new API project with breaking changes (#152)

* feat!: Replace the type property by _type * feat!: Define listeners as a component
lenra-io · Sep 15, 2023 · c6584e7 · c6584e7
1 parent 9e8519f
commit c6584e7
Show file tree

Hide file tree

Showing 31 changed files with 140 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ The `text` key must describe a text that is displayed inside the component.
 ### The listeners
 
 All the listeners must start with `on` and be passed `onPressed`, `onChanged`...
-All listeners MUST have the `action` property and MAY have the `props` object property.
+All listeners MUST have the `name` property and MAY have the `props` object property.
 
 #### The `onPressed` listener
 
@@ -70,7 +70,8 @@ Do NOT use the `onClick` or `onTap` key.
  [...]
  "listeners": {
  "onPressed": {
- "action": "toggleCheckbox"
+ "_type": "listener",
+ "name": "toggleCheckbox"
  },
  }
 }
@@ -85,7 +86,8 @@ This listener is never called when the value is changed programatically.
  "type": "textfield",
  "listeners": {
  "onChanged": {
- "action": "myAction",
+ "_type": "listener",
+ "name": "myAction",
  }
  }
 }

diff --git a/api/components/actionable.schema.json b/api/components/actionable.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Actionable",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "actionable"
@@ -16,23 +16,23 @@
  },
  "onPressed": {
  "description": "The listener to be called when the actionable is pressed.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "onDoublePressed": {
  "description": "The listener to be called when the actionable is double pressed.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "onLongPressed": {
  "description": "The listener to be called when the actionable is long pressed.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "onPressedCancel": {
  "description": "The listener to be called when the actionable is pressed inside and released outside of the actionable, causing it to cancel the press action.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "onHovered": {
  "description": "The listener to be called when the actionable is hovered and when the mouse exits the hoverable area.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "submit": {
  "description": "Whether the actionable can submit a form.",
@@ -41,7 +41,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "child"
  ],
  "additionalProperties": false

diff --git a/api/components/button.schema.json b/api/components/button.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Button",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "button"
@@ -27,7 +27,7 @@
  "$ref": "../defs/style.schema.json"
  },
  "onPressed": {
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "leftIcon": {
  "$ref": "../components/icon.schema.json"
@@ -42,7 +42,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "text"
  ],
  "additionalProperties": false

diff --git a/api/components/carousel.schema.json b/api/components/carousel.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Carousel",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "carousel"
@@ -23,7 +23,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "children"
  ],
  "additionalProperties": false

diff --git a/api/components/checkbox.schema.json b/api/components/checkbox.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Checkbox",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "checkbox"
@@ -20,7 +20,7 @@
  "type": "boolean"
  },
  "onPressed": {
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "style": {
  "$ref": "../defs/checkboxStyle.schema.json"
@@ -38,7 +38,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "value"
  ],
  "additionalProperties": false

diff --git a/api/components/container.schema.json b/api/components/container.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type container",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "container"
@@ -31,7 +31,7 @@
  }
  },
  "required": [
- "type"
+ "_type"
  ],
  "additionalProperties": false
 }
diff --git a/api/components/dropdownButton.schema.json b/api/components/dropdownButton.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Dropdown Button",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "dropdownButton"
@@ -34,7 +34,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "text",
  "child"
  ],

diff --git a/api/components/flex.schema.json b/api/components/flex.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Flex",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "flex"
@@ -75,7 +75,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "children"
  ],
  "additionalProperties": false

diff --git a/api/components/flexible.schema.json b/api/components/flexible.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Flexible",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "flexible"
@@ -24,7 +24,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "child"
  ],
  "additionalProperties": false

diff --git a/api/components/form.schema.json b/api/components/form.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Form",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "form"
@@ -16,11 +16,11 @@
  },
  "onSubmit": {
  "description": "Callback when the user submits the form.",
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  }
  },
  "required": [
- "type",
+ "_type",
  "child"
  ],
  "additionalProperties": false

diff --git a/api/components/icon.schema.json b/api/components/icon.schema.json
@@ -6,11 +6,11 @@
  "type": "component",
  "additionalProperties": false,
  "required": [
- "type",
+ "_type",
  "value"
  ],
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "icon"

diff --git a/api/components/image.schema.json b/api/components/image.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Image",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "image"
@@ -76,7 +76,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "src"
  ],
  "additionalProperties": false

diff --git a/api/defs/listener.schema.json → api/components/listener.schema.json b/api/defs/listener.schema.json → api/components/listener.schema.json
@@ -4,8 +4,13 @@
  "title": "Listener",
  "type": "listener",
  "properties": {
- "action": {
- "description": "The action name to call",
+ "_type": {
+ "enum": [
+ "listener"
+ ]
+ },
+ "name": {
+ "description": "The listener name to call",
  "type": "string",
  "pattern": "^(@lenra:)?[a-zA-Z_$][a-zA-Z_.$0-9]*$"
  },
@@ -15,7 +20,8 @@
  }
  },
  "required": [
- "action"
+ "_type",
+ "name"
  ],
  "additionalProperties": false
 }
diff --git a/api/components/menu.schema.json b/api/components/menu.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Menu",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "menu"
@@ -20,7 +20,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "children"
  ],
  "additionalProperties": false

diff --git a/api/components/menuItem.schema.json b/api/components/menuItem.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type MenuItem",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "menuItem"
@@ -29,11 +29,11 @@
  "$ref": "../components/icon.schema.json"
  },
  "onPressed": {
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  }
  },
  "required": [
- "type",
+ "_type",
  "text"
  ],
  "additionalProperties": false

diff --git a/api/components/overlayEntry.schema.json b/api/components/overlayEntry.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type OverlayEntry",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The identifier of the component",
  "enum": [
  "overlayEntry"
@@ -32,7 +32,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "child"
  ],
  "additionalProperties": false

diff --git a/api/components/radio.schema.json b/api/components/radio.schema.json
@@ -5,7 +5,7 @@
  "description": "Element of type Radio",
  "type": "component",
  "properties": {
- "type": {
+ "_type": {
  "description": "The type of the element",
  "enum": [
  "radio"
@@ -28,7 +28,7 @@
  "$ref": "../defs/materialTapTargetSize.schema.json"
  },
  "onPressed": {
- "$ref": "../defs/listener.schema.json"
+ "$ref": "../components/listener.schema.json"
  },
  "toggleable": {
  "description": "Whether the radio is allowed to go from checked to unchecked when clicking on it.",
@@ -43,7 +43,7 @@
  }
  },
  "required": [
- "type",
+ "_type",
  "value",
  "groupValue"
  ],