@twin.org/image 0.0.1-next.6 → 0.0.1-next.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/docs/changelog.md +155 -1
  2. package/docs/reference/classes/Color.md +25 -13
  3. package/docs/reference/classes/JpegEncoder.md +15 -7
  4. package/docs/reference/classes/PngEncoder.md +14 -8
  5. package/package.json +4 -4
package/docs/changelog.md CHANGED
@@ -1,5 +1,159 @@
1
1
  # @twin.org/image - Changelog
2
2
 
3
- ## 0.0.1-next.6
3
+ ## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.59...image-v0.0.1-next.60) (2025-06-17)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **image:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
16
+
17
+ ## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.58...image-v0.0.1-next.59) (2025-06-17)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **image:** Synchronize repo versions
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
30
+
31
+ ## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.57...image-v0.0.1-next.58) (2025-06-13)
32
+
33
+
34
+ ### Miscellaneous Chores
35
+
36
+ * **image:** Synchronize repo versions
37
+
38
+
39
+ ### Dependencies
40
+
41
+ * The following workspace dependencies were updated
42
+ * dependencies
43
+ * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
44
+
45
+ ## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.56...image-v0.0.1-next.57) (2025-06-10)
46
+
47
+
48
+ ### Features
49
+
50
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
51
+
52
+
53
+ ### Dependencies
54
+
55
+ * The following workspace dependencies were updated
56
+ * dependencies
57
+ * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
58
+
59
+ ## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.55...image-v0.0.1-next.56) (2025-05-08)
60
+
61
+
62
+ ### Miscellaneous Chores
63
+
64
+ * **image:** Synchronize repo versions
65
+
66
+
67
+ ### Dependencies
68
+
69
+ * The following workspace dependencies were updated
70
+ * dependencies
71
+ * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
72
+
73
+ ## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.54...image-v0.0.1-next.55) (2025-05-07)
74
+
75
+
76
+ ### Miscellaneous Chores
77
+
78
+ * **image:** Synchronize repo versions
79
+
80
+
81
+ ### Dependencies
82
+
83
+ * The following workspace dependencies were updated
84
+ * dependencies
85
+ * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
86
+
87
+ ## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.53...image-v0.0.1-next.54) (2025-05-06)
88
+
89
+
90
+ ### Miscellaneous Chores
91
+
92
+ * **image:** Synchronize repo versions
93
+
94
+
95
+ ### Dependencies
96
+
97
+ * The following workspace dependencies were updated
98
+ * dependencies
99
+ * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
100
+
101
+ ## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.52...image-v0.0.1-next.53) (2025-05-01)
102
+
103
+
104
+ ### Miscellaneous Chores
105
+
106
+ * **image:** Synchronize repo versions
107
+
108
+
109
+ ### Dependencies
110
+
111
+ * The following workspace dependencies were updated
112
+ * dependencies
113
+ * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
114
+
115
+ ## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.51...image-v0.0.1-next.52) (2025-04-17)
116
+
117
+
118
+ ### Features
119
+
120
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
128
+
129
+ ## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.50...image-v0.0.1-next.51) (2025-03-27)
130
+
131
+
132
+ ### Miscellaneous Chores
133
+
134
+ * **image:** Synchronize repo versions
135
+
136
+
137
+ ### Dependencies
138
+
139
+ * The following workspace dependencies were updated
140
+ * dependencies
141
+ * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
142
+
143
+ ## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.49...image-v0.0.1-next.50) (2025-03-26)
144
+
145
+
146
+ ### Miscellaneous Chores
147
+
148
+ * **image:** Synchronize repo versions
149
+
150
+
151
+ ### Dependencies
152
+
153
+ * The following workspace dependencies were updated
154
+ * dependencies
155
+ * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
156
+
157
+ ## 0.0.1-next.49
4
158
 
5
159
  - Initial Release
package/docs/reference/classes/Color.md CHANGED
@@ -4,51 +4,61 @@ Class to represent a color.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new Color()
7
+ ### Constructor
8
8
 
9
- > **new Color**(`alpha`, `red`, `green`, `blue`): [`Color`](Color.md)
9
+ > **new Color**(`alpha`, `red`, `green`, `blue`): `Color`
10
10
 
11
11
  Create a new instance of color.
12
12
 
13
13
  #### Parameters
14
14
 
15
- • **alpha**: `number`
15
+ ##### alpha
16
+
17
+ `number`
16
18
 
17
19
  The alpha element of the color.
18
20
 
19
- • **red**: `number`
21
+ ##### red
22
+
23
+ `number`
20
24
 
21
25
  The red element of the color.
22
26
 
23
- • **green**: `number`
27
+ ##### green
28
+
29
+ `number`
24
30
 
25
31
  The green element of the color.
26
32
 
27
- • **blue**: `number`
33
+ ##### blue
34
+
35
+ `number`
28
36
 
29
37
  The blue element of the color.
30
38
 
31
39
  #### Returns
32
40
 
33
- [`Color`](Color.md)
41
+ `Color`
34
42
 
35
43
  ## Methods
36
44
 
37
45
  ### fromHex()
38
46
 
39
- > `static` **fromHex**(`hex`): [`Color`](Color.md)
47
+ > `static` **fromHex**(`hex`): `Color`
40
48
 
41
49
  Construct a color from a hex string.
42
50
 
43
51
  #### Parameters
44
52
 
45
- • **hex**: `string`
53
+ ##### hex
54
+
55
+ `string`
46
56
 
47
57
  The hex string to parse.
48
58
 
49
59
  #### Returns
50
60
 
51
- [`Color`](Color.md)
61
+ `Color`
52
62
 
53
63
  The color.
54
64
 
@@ -60,19 +70,21 @@ Error if the format is incorrect.
60
70
 
61
71
  ### coerce()
62
72
 
63
- > `static` **coerce**(`value`): `undefined` \| [`Color`](Color.md)
73
+ > `static` **coerce**(`value`): `undefined` \| `Color`
64
74
 
65
75
  Coerce an unknown type to a color.
66
76
 
67
77
  #### Parameters
68
78
 
69
- • **value**: `unknown`
79
+ ##### value
80
+
81
+ `unknown`
70
82
 
71
83
  The value to try and convert.
72
84
 
73
85
  #### Returns
74
86
 
75
- `undefined` \| [`Color`](Color.md)
87
+ `undefined` \| `Color`
76
88
 
77
89
  The color if one can be created.
78
90
 
package/docs/reference/classes/JpegEncoder.md CHANGED
@@ -5,15 +5,15 @@ Based on JPEG encoder ported to JavaScript and optimized by Andreas Ritter.
5
5
 
6
6
  ## Constructors
7
7
 
8
- ### new JpegEncoder()
8
+ ### Constructor
9
9
 
10
- > **new JpegEncoder**(): [`JpegEncoder`](JpegEncoder.md)
10
+ > **new JpegEncoder**(): `JpegEncoder`
11
11
 
12
12
  Create a new instance of JpegEncoder.
13
13
 
14
14
  #### Returns
15
15
 
16
- [`JpegEncoder`](JpegEncoder.md)
16
+ `JpegEncoder`
17
17
 
18
18
  ## Methods
19
19
 
@@ -25,19 +25,27 @@ Encode the image with the given quality.
25
25
 
26
26
  #### Parameters
27
27
 
28
- • **width**: `number`
28
+ ##### width
29
+
30
+ `number`
29
31
 
30
32
  The width of the image to encode.
31
33
 
32
- • **height**: `number`
34
+ ##### height
35
+
36
+ `number`
33
37
 
34
38
  The height of the image to encode.
35
39
 
36
- • **imageData**: `Uint8Array`
40
+ ##### imageData
41
+
42
+ `Uint8Array`
37
43
 
38
44
  The data for the image.
39
45
 
40
- • **quality**: `number`
46
+ ##### quality
47
+
48
+ `number`
41
49
 
42
50
  The quality to encode the image at.
43
51
 
package/docs/reference/classes/PngEncoder.md CHANGED
@@ -5,38 +5,44 @@ Based on https://github.com/photopea/UPNG.js.
5
5
 
6
6
  ## Constructors
7
7
 
8
- ### new PngEncoder()
8
+ ### Constructor
9
9
 
10
- > **new PngEncoder**(): [`PngEncoder`](PngEncoder.md)
10
+ > **new PngEncoder**(): `PngEncoder`
11
11
 
12
12
  #### Returns
13
13
 
14
- [`PngEncoder`](PngEncoder.md)
14
+ `PngEncoder`
15
15
 
16
16
  ## Methods
17
17
 
18
18
  ### encode()
19
19
 
20
- > **encode**(`buffers`, `w`, `h`): `Promise`\<`Uint8Array`\>
20
+ > **encode**(`buffers`, `w`, `h`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
21
21
 
22
22
  Encode the image frames to png.
23
23
 
24
24
  #### Parameters
25
25
 
26
- • **buffers**: `ArrayBuffer`[]
26
+ ##### buffers
27
+
28
+ `ArrayBuffer`[]
27
29
 
28
30
  The frame buffers to encode.
29
31
 
30
- • **w**: `number`
32
+ ##### w
33
+
34
+ `number`
31
35
 
32
36
  The image width.
33
37
 
34
- • **h**: `number`
38
+ ##### h
39
+
40
+ `number`
35
41
 
36
42
  The image height.
37
43
 
38
44
  #### Returns
39
45
 
40
- `Promise`\<`Uint8Array`\>
46
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
41
47
 
42
48
  The data for the image.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/image",
3
- "version": "0.0.1-next.6",
3
+ "version": "0.0.1-next.60",
4
4
  "description": "Classes for image manipulation",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.1-next.6",
17
+ "@twin.org/core": "0.0.1-next.60",
18
18
  "@twin.org/nameof": "next"
19
19
  },
20
20
  "main": "./dist/cjs/index.cjs",
@@ -22,9 +22,9 @@
22
22
  "types": "./dist/types/index.d.ts",
23
23
  "exports": {
24
24
  ".": {
25
+ "types": "./dist/types/index.d.ts",
25
26
  "require": "./dist/cjs/index.cjs",
26
- "import": "./dist/esm/index.mjs",
27
- "types": "./dist/types/index.d.ts"
27
+ "import": "./dist/esm/index.mjs"
28
28
  }
29
29
  },
30
30
  "files": [