Skip to content

Commit aeec35e

Browse files
committed
Clean up changelog
1 parent 651d52f commit aeec35e

File tree

1 file changed

+153
-59
lines changed

1 file changed

+153
-59
lines changed

CHANGELOG.md

Lines changed: 153 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,153 @@
1-
## 1.0 Changes
2-
3-
### Breaking Changes
4-
* Change all `send.pipe` externals to `send`, making the whole project "t-first" (#8)
5-
* Some `Node` APIs do not trigger compile errors due to the argument swap, because both arguments were `Node` instances. This logic error can cause severe migration headaches; the following methods had named arguments added to highlight places migration is necessary (#89)
6-
* `appendChild`
7-
* `compareDocumentPosition`
8-
* `contains`
9-
* `insertBefore`
10-
* `removeChild`
11-
* `replaceChild`
12-
* Imported `bs-fetch` as `Webapi.Fetch` and converted it to "t-first" (#31)
13-
* Removed deprecated APIs (#16)
14-
* Removed `preview` from File bindings. It doesn't seem to be in any specifications. (#56)
15-
* Removed `type_` from `Fetch.Request` module. It doesn't seem to be in any specifications. (#67)
16-
* Updated `Window.getSelection` binding to return an option (#15)
17-
* Updated `getClientRects` binding on `Document` and `Range` to return a `Dom.RectList.t` (#36)
18-
* Updated `Document.elementFromPoint` binding to return a nullable value (#35)
19-
* Updated `MutationRecord` bindings `nextSibling`, `attributeName`, `attributeNamespace` and `oldValue` to return nullable values (#59)
20-
* Corrected spelling of `nextSibling` in `MutationRecord` (#59)
21-
* Updated `History.scrollRestoration` to use `auto` and `manual` instead of a boolean (#88)
22-
* `PopStateEvent.state` now returns a history state type instead of an open object (#88)
23-
* Updated `InputEvent.data` to return a nullable value (#90)
24-
* Corrected return type of `selectionStart` and `selectionEnd` for `input` and `textarea` elements (#124)
25-
26-
### Added (non-breaking)
27-
* `WebSocket` bindings (#34)
28-
* `Canvas2d.newPath2D()` to bind `Path2D` objects (#45)
29-
* `IntersectionObserver` and `IntersectionObserverEntry` bindings (#27)
30-
* `scrollToWithOptions` binding to `window` (#26)
31-
* `HtmlDocument` bindings `hasFocus` and `activeElement` moved to `Document` (#41)
32-
* They're still available on `HtmlDocument` thanks to the `include` structure
33-
* `StaticRange` bindings (#48)
34-
* Added bindings for the File constructor (#56)
35-
* Added bindings for the Blob constructor (#56)
36-
* `DataTransfer` bindings (#51)
37-
* `WorkerGlobalScope`, `WindowOrWorkerGlobalScope`, `WorkerNavigator`, and `WorkerLocation` bindings (#57)
38-
* `Response` constructors to `Fetch` bindings (#64)
39-
* `HTMLFormControlsCollection`, `HTMLOptionsCollection`, `HTMLFieldSetElement`, `Document.forms`, `HTMLFormElement.elements`, `HTMLObjectElement`, `HTMLOptGroupElement`, `HTMLOptionElement`, `HTMLOutputElement`, `HTMLSelectElement`, `HTMLTextAreaElement`, and `RadioNodeList` bindings (#73)
40-
* `Canvas2d` bindings `drawImage`, `drawImageScale`, and `drawImageFull` added (#83)
41-
* `InputEvent` bindings for `inputType`, `dataTransfer` and `getTargetRanges` (#90)
42-
* `Node.insertAtEnd` binding (which does `parent.insertBefore(child, null)`) (#89)
43-
* CustomEvent Functor to make custom events with strongly typed `detail` fields (#93)
44-
* `Url.createObjectURLFromBlob` binding that takes a `Blob.t` (#106)
45-
* `returnValue` setter for `BeforeUnloadEvent` (#110)
46-
* `Webapi.FormData.makeWithHtmlForm` binding that takes a `Webapi.Dom.HtmlFormElement.t` (#108)
47-
* `Canvas.toBlob` & `Canvas.toDataUrl` methods, with multiple argument variants (#111)
48-
* `OffscreenCanvas` bindings (#119)
49-
50-
### Fixed
51-
* `ofElement` was incorrectly returning `Dom.htmlElement` type instead of the enclosing element type (#60)
52-
* `Dom.CssStyleDeclaration.setPropertyValue` was emitting the wrong function name (#114)
53-
* `Url.toJSON()` was emitting the wrong function name (#121)
54-
* The `options` signature in `Webapi.Dom.CustomEvent`'s `makeWithOption` (#122)
55-
56-
### Miscellaneous
57-
* Converted project to rescript syntax (#18)
58-
* Added explicit values to all externals instead of using `= ""` (#40)
59-
* Deprecated `Node.isSameNode` (MDN recommends using `===` instead) (#89)
1+
# Changelog
2+
3+
> **Tags:**
4+
>
5+
> - :boom: [Breaking Change]
6+
> - :rocket: [New Feature]
7+
> - :bug: [Bug Fix]
8+
> - :memo: [Documentation]
9+
> - :house: [Internal]
10+
> - :nail_care: [Polish]
11+
12+
## main
13+
14+
#### :boom: Breaking Change
15+
16+
- Corrected return type of `selectionStart` and `selectionEnd` for `input` and `textarea` elements. https://github.com/TheSpyder/rescript-webapi/pull/124
17+
18+
#### :bug: Bug Fix
19+
20+
- Fix compatibility with ReScript 11 uncurried mode. https://github.com/TheSpyder/rescript-webapi/pull/123
21+
22+
## 0.8.0
23+
24+
#### :rocket: New Feature
25+
26+
- `OffscreenCanvas` bindings. https://github.com/TheSpyder/rescript-webapi/pull/119
27+
28+
#### :bug: Bug Fix
29+
30+
- `Url.toJSON()` was emitting the wrong function name. https://github.com/TheSpyder/rescript-webapi/pull/121
31+
- The `options` signature in `Webapi.Dom.CustomEvent`'s `makeWithOption`. https://github.com/TheSpyder/rescript-webapi/pull/122
32+
33+
## 0.7.0
34+
35+
#### :rocket: New Feature
36+
37+
- `Url.createObjectURLFromBlob` binding that takes a `Blob.t`. https://github.com/TheSpyder/rescript-webapi/pull/106
38+
- `returnValue` setter for `BeforeUnloadEvent`. https://github.com/TheSpyder/rescript-webapi/pull/110
39+
- `Webapi.FormData.makeWithHtmlForm` binding that takes a `Webapi.Dom.HtmlFormElement.t`. https://github.com/TheSpyder/rescript-webapi/pull/108
40+
- `Canvas.toBlob` & `Canvas.toDataUrl` methods, with multiple argument variants. https://github.com/TheSpyder/rescript-webapi/pull/111
41+
42+
#### :bug: Bug Fix
43+
44+
- `Dom.CssStyleDeclaration.setPropertyValue` was emitting the wrong function name. https://github.com/TheSpyder/rescript-webapi/pull/114
45+
46+
## 0.6.1
47+
48+
#### :rocket: New Feature
49+
50+
- CustomEvent Functor to make custom events with strongly typed `detail` fields. https://github.com/TheSpyder/rescript-webapi/pull/93
51+
52+
## 0.5.0
53+
54+
#### :boom: Breaking Change
55+
56+
- Some `Node` APIs do not trigger compile errors due to the argument swap, because both arguments were `Node` instances. This logic error can cause severe migration headaches; the following methods had named arguments added to highlight places migration is necessary. https://github.com/TheSpyder/rescript-webapi/pull/89
57+
- `appendChild`
58+
- `compareDocumentPosition`
59+
- `contains`
60+
- `insertBefore`
61+
- `removeChild`
62+
- `replaceChild`
63+
- Updated `History.scrollRestoration` to use `auto` and `manual` instead of a boolean. https://github.com/TheSpyder/rescript-webapi/pull/88
64+
- `PopStateEvent.state` now returns a history state type instead of an open object. https://github.com/TheSpyder/rescript-webapi/pull/88
65+
- Updated `InputEvent.data` to return a nullable value. https://github.com/TheSpyder/rescript-webapi/pull/90
66+
67+
#### :rocket: New Feature
68+
69+
- `Canvas2d` bindings `drawImage`, `drawImageScale`, and `drawImageFull` added. https://github.com/TheSpyder/rescript-webapi/pull/83
70+
- `InputEvent` bindings for `inputType`, `dataTransfer` and `getTargetRanges`. https://github.com/TheSpyder/rescript-webapi/pull/90
71+
- `Node.insertAtEnd` binding (which does `parent.insertBefore(child, null)`). https://github.com/TheSpyder/rescript-webapi/pull/89
72+
73+
#### :house: Internal
74+
75+
- Deprecated `Node.isSameNode` (MDN recommends using `===` instead). https://github.com/TheSpyder/rescript-webapi/pull/89
76+
77+
## 0.4.1
78+
79+
#### :rocket: New Feature
80+
81+
- Added `HTMLFormControlsCollection`, `HTMLOptionsCollection`, `HTMLFieldSetElement`, `Document.forms`, `HTMLFormElement.elements`, `HTMLObjectElement`, `HTMLOptGroupElement`, `HTMLOptionElement`, `HTMLOutputElement`, `HTMLSelectElement`, `HTMLTextAreaElement`, and `RadioNodeList` bindings. https://github.com/TheSpyder/rescript-webapi/pull/73
82+
83+
## 0.3.2
84+
85+
#### :bug: Bug Fix
86+
87+
- `ofElement` was incorrectly returning `Dom.htmlElement` type instead of the enclosing element type. https://github.com/TheSpyder/rescript-webapi/pull/60
88+
89+
## 0.3.1
90+
91+
#### :boom: Breaking Change
92+
93+
- Removed `type_` from `Fetch.Request` module. It doesn't seem to be in any specifications.. https://github.com/TheSpyder/rescript-webapi/pull/67
94+
95+
## 0.3.0
96+
97+
#### :boom: Breaking Change
98+
99+
- Removed `preview` from File bindings. It doesn't seem to be in any specifications.. https://github.com/TheSpyder/rescript-webapi/pull/56
100+
- Updated `MutationRecord` bindings `nextSibling`, `attributeName`, `attributeNamespace` and `oldValue` to return nullable values. https://github.com/TheSpyder/rescript-webapi/pull/59
101+
- Corrected spelling of `nextSibling` in `MutationRecord`. https://github.com/TheSpyder/rescript-webapi/pull/59
102+
103+
#### :rocket: New Feature
104+
105+
- `StaticRange` bindings. https://github.com/TheSpyder/rescript-webapi/pull/48
106+
- Added bindings for the File constructor. https://github.com/TheSpyder/rescript-webapi/pull/56
107+
- Added bindings for the Blob constructor. https://github.com/TheSpyder/rescript-webapi/pull/56
108+
- `DataTransfer` bindings. https://github.com/TheSpyder/rescript-webapi/pull/51
109+
- `WorkerGlobalScope`, `WindowOrWorkerGlobalScope`, `WorkerNavigator`, and `WorkerLocation` bindings. https://github.com/TheSpyder/rescript-webapi/pull/57
110+
- `Response` constructors to `Fetch` bindings. https://github.com/TheSpyder/rescript-webapi/pull/64
111+
112+
## 0.2.0
113+
114+
#### :boom: Breaking Change
115+
116+
- Updated `Document.elementFromPoint` binding to return a nullable value. https://github.com/TheSpyder/rescript-webapi/pull/35
117+
- Updated `getClientRects` binding on `Document` and `Range` to return a `Dom.RectList.t`. https://github.com/TheSpyder/rescript-webapi/pull/36
118+
119+
#### :rocket: New Feature
120+
121+
- `WebSocket` bindings. https://github.com/TheSpyder/rescript-webapi/pull/34
122+
- `Canvas2d.newPath2D()` to bind `Path2D` objects. https://github.com/TheSpyder/rescript-webapi/pull/45
123+
- `HtmlDocument` bindings `hasFocus` and `activeElement` moved to `Document`. https://github.com/TheSpyder/rescript-webapi/pull/41
124+
- They're still available on `HtmlDocument` thanks to the `include` structure
125+
126+
#### :house: Internal
127+
128+
- Added explicit values to all externals instead of using `= ""`. https://github.com/TheSpyder/rescript-webapi/pull/40
129+
130+
## 0.1.3
131+
132+
#### :boom: Breaking Change
133+
134+
- Imported `bs-fetch` as `Webapi.Fetch` and converted it to "t-first". https://github.com/TheSpyder/rescript-webapi/pull/31
135+
136+
#### :house: Internal
137+
138+
- Converted project to rescript syntax. https://github.com/TheSpyder/rescript-webapi/pull/18
139+
140+
## 0.1.2
141+
142+
#### :rocket: New Feature
143+
144+
- `scrollToWithOptions` binding to `window`. https://github.com/TheSpyder/rescript-webapi/pull/26
145+
- `IntersectionObserver` and `IntersectionObserverEntry` bindings. https://github.com/TheSpyder/rescript-webapi/pull/27
146+
147+
## 0.1.1
148+
149+
#### :boom: Breaking Change
150+
151+
- Changed all `send.pipe` externals to `send`, making the whole project "t-first". https://github.com/TheSpyder/rescript-webapi/pull/8
152+
- Removed deprecated APIs. https://github.com/TheSpyder/rescript-webapi/pull/16
153+
- Updated `Window.getSelection` binding to return an option. https://github.com/TheSpyder/rescript-webapi/pull/15

0 commit comments

Comments
 (0)