feat: add ImageRun

README.md

@@ -75,16 +75,12 @@ See which features are covered in the dedicated [doc file](https://github.com/Em
 * 🚧 Sections
 * ✅ Paragraph
 * 🚧 Text
-* ❌ Images
+* 🚧 Images (_Missing correct modelization of the `ImageRun.options.data` type_)
 * ✅ Headers & Footers
 * ❌ Bullet Points
 * ✅ Hyperlinks
 * ❌ Numbering
-* 🚧 Tables
-    * ✅ Table
-    * ✅ TableCell
-    * ✅ TableRow
-    * ❌ TableColumn
+* ✅ Tables
 * ❌ Tabs
 * ❌ Table Of Contents
 * ✅ Page Numbers

examples/Example.res

@@ -0,0 +1,35 @@
+open Util
+
+let table = Table.make({
+  rows: [
+    TableRow.make({
+      children: [
+        TableCell.make({
+          children: [
+            Paragraph.make'({
+              children: [
+                ImageRun.make({
+                  data: NodeJs.Fs.readFileSync("./images/1.jpg"),
+                  transformation: {
+                    width: 100.0,
+                    height: 100.0,
+                  },
+                }),
+              ],
+            })->Types.ParagraphOrTable.fromParagraph,
+          ],
+          verticalAlign: #center,
+        }),
+        TableCell.make({
+          children: [
+            Paragraph.make'({
+              text: "Hello",
+              heading: #Heading1,
+            })->Types.ParagraphOrTable.fromParagraph,
+          ],
+          verticalAlign: #center,
+        }),
+      ],
+    }),
+  ],
+})

src/Floating.res

@@ -0,0 +1,19 @@
+type margins = {
+  bottom?: float,
+  left?: float,
+  right?: float,
+  top?: float,
+}
+
+/** @see https://docx.js.org/api/interfaces/IFloating.html */
+type t = {
+  allowOverlap?: bool,
+  behindDocument?: bool,
+  horizontalPosition?: HorizontalPositionOptions.t,
+  layoutInCell?: bool,
+  lockAnchor?: bool,
+  margins?: margins,
+  verticalPosition: VerticalPositionOptions.t,
+  wrap?: TextWrapping.t,
+  zIndex?: int,
+}

src/HorizontalPositionOptions.res

@@ -0,0 +1,25 @@
+type horizontalPositionAlign = [
+  | #center
+  | #inside
+  | #left
+  | #outside
+  | #right
+]
+
+type horizontalPositionRelativeFrom = [
+  | #character
+  | #column
+  | #insideMargin
+  | #leftMargin
+  | #margin
+  | #outsideMargin
+  | #page
+  | #rightMargin
+]
+
+/** @see https://docx.js.org/api/interfaces/IHorizontalPositionOptions.html */
+type t = {
+  align?: horizontalPositionAlign,
+  offset?: float,
+  relative?: horizontalPositionRelativeFrom,
+}

src/ImageRun.res

@@ -0,0 +1,20 @@
+type docPropertiesOptions = {
+  name: string,
+  dscription: string,
+  title: string,
+}
+
+type options<'a> = {
+  /**
+   * FIXME: should be equivalent to: string  | Buffer | Uint8Array | ArrayBuffer
+   * 
+   * @see https://docx.js.org/api/interfaces/IImageOptions.html#data
+   */
+  data: 'a,
+  transformation: MediaTransformation.t,
+  altText?: docPropertiesOptions,
+  floating?: Floating.t,
+}
+
+@module("docx") @new
+external make: options<'a> => ParagraphChild.t = "ImageRun"

src/MediaTransformation.res

@@ -0,0 +1,11 @@
+/** @see https://docx.js.org/api/interfaces/IMediaTransformation.html */
+type rec t = {
+  height: float,
+  width: float,
+  flip?: flip,
+  rotation?: float,
+}
+and flip = {
+  horizontal?: bool,
+  vertical?: bool,
+}

src/TextWrapping.res

@@ -0,0 +1,27 @@
+type distance = {
+  distB?: float,
+  distL?: float,
+  distR?: float,
+  distT?: float,
+}
+
+type textWrappingSide = [
+  | #bothSides
+  | #largest
+  | #left
+  | #right
+]
+
+/** @see https://docx.js.org/api/enums/TextWrappingType.html */
+type textWrappingType =
+  | None
+  | Square
+  | Tight
+  | Top_And_Bottom
+
+/** @see https://docx.js.org/api/interfaces/ITextWrapping.html */
+type t = {
+  margins?: distance,
+  side?: textWrappingSide,
+  @as("type") type_: textWrappingType,
+}

src/Util.res

@@ -15,35 +15,42 @@ module Types = {
     let make = (~negative=false, ~val: float) =>
       `${negative ? "-" : ""}${val->Belt.Float.toString}%`
   }
-  // TODO: should be more precise and model the fact that the value could be a 'positive' universal measure
-  module NumberOrUniversalMeasure = {
+
+  module Number = {
     type t
 
     external fromFloat: float => t = "%identity"
-    external fromString: string => t = "%identity"
   }
 
-  module NumberOrPositiveUniversalMeasure = {
+  module Bool = {
     type t
 
-    external fromFloat: float => t = "%identity"
-    external fromString: string => t = "%identity"
+    external fromBool: bool => t = "%identity"
+  }
+
+  // TODO: should be more precise and model the fact that the value could be a 'positive' universal measure
+  module NumberOrUniversalMeasure = {
+    include Number
+
+    external fromUniversalMeasure: string => t = "%identity"
+  }
+
+  module NumberOrPositiveUniversalMeasure = {
+    include Number
+
+    external fromPositiveUniversalMeasure: string => t = "%identity"
   }
 
   module BoolOrNumberOrUniversalMeasure = {
-    type t
+    include NumberOrUniversalMeasure
 
     external fromBool: bool => t = "%identity"
-    external fromFloat: float => t = "%identity"
-    external fromString: string => t = "%identity"
   }
 
   module NumberOrPercentageOrUniversalMeasure = {
-    type t
+    include NumberOrUniversalMeasure
 
     external fromPercentage: Percentage.t => t = "%identity"
-    external fromFloat: float => t = "%identity"
-    external fromString: string => t = "%identity"
   }
 
   module BoolOrString = {

src/VerticalPositionOptions.res

@@ -0,0 +1,25 @@
+type horizontalPositionAlign = [
+  | #center
+  | #inside
+  | #bottom
+  | #outside
+  | #top
+]
+
+type horizontalPositionRelativeFrom = [
+  | #character
+  | #column
+  | #insideMargin
+  | #bottomMargin
+  | #margin
+  | #outsideMargin
+  | #page
+  | #topMargin
+]
+
+/** @see https://docx.js.org/api/interfaces/IHorizontalPositionOptions.html */
+type t = {
+  align?: horizontalPositionAlign,
+  offset?: float,
+  relative?: horizontalPositionRelativeFrom,
+}