@twin.org/image 0.0.1-next.8 → 0.0.1

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.
package/docs/changelog.md CHANGED
@@ -1,5 +1,335 @@
1
1
  # @twin.org/image - Changelog
2
2
 
3
- ## 0.0.1-next.8
3
+ ## 0.0.1 (2025-07-03)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([829d53d](https://github.com/twinfoundation/framework/commit/829d53d3953b1e1b40b0243c04cfdfd3842aac7b))
9
+ * release to production ([5cf3a76](https://github.com/twinfoundation/framework/commit/5cf3a76a09eff2e6414d0cba846c7c37400a11d6))
10
+
11
+
12
+ ### Dependencies
13
+
14
+ * The following workspace dependencies were updated
15
+ * dependencies
16
+ * @twin.org/core bumped from ^0.0.0 to ^0.0.1
17
+ * @twin.org/nameof bumped from ^0.0.0 to ^0.0.1
18
+ * devDependencies
19
+ * @twin.org/nameof-transformer bumped from ^0.0.0 to ^0.0.1
20
+ * @twin.org/nameof-vitest-plugin bumped from ^0.0.0 to ^0.0.1
21
+
22
+ ## [0.0.1-next.70](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.69...image-v0.0.1-next.70) (2025-07-02)
23
+
24
+
25
+ ### Features
26
+
27
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
28
+ * relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
29
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
30
+
31
+
32
+ ### Dependencies
33
+
34
+ * The following workspace dependencies were updated
35
+ * dependencies
36
+ * @twin.org/core bumped from 0.0.1-next.69 to 0.0.1-next.70
37
+ * @twin.org/nameof bumped from 0.0.1-next.69 to 0.0.1-next.70
38
+ * devDependencies
39
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.69 to 0.0.1-next.70
40
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.69 to 0.0.1-next.70
41
+
42
+ ## [0.0.1-next.69](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.68...image-v0.0.1-next.69) (2025-07-02)
43
+
44
+
45
+ ### Features
46
+
47
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
48
+ * relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
49
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
50
+
51
+
52
+ ### Dependencies
53
+
54
+ * The following workspace dependencies were updated
55
+ * dependencies
56
+ * @twin.org/core bumped from 0.0.1-next.68 to 0.0.1-next.69
57
+ * @twin.org/nameof bumped from 0.0.1-next.68 to 0.0.1-next.69
58
+ * devDependencies
59
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.68 to 0.0.1-next.69
60
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.68 to 0.0.1-next.69
61
+
62
+ ## [0.0.1-next.68](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.67...image-v0.0.1-next.68) (2025-07-02)
63
+
64
+
65
+ ### Features
66
+
67
+ * relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
68
+
69
+
70
+ ### Dependencies
71
+
72
+ * The following workspace dependencies were updated
73
+ * dependencies
74
+ * @twin.org/core bumped from 0.0.1-next.67 to 0.0.1-next.68
75
+ * @twin.org/nameof bumped from 0.0.1-next.67 to 0.0.1-next.68
76
+ * devDependencies
77
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.67 to 0.0.1-next.68
78
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.67 to 0.0.1-next.68
79
+
80
+ ## [0.0.1-next.67](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.66...image-v0.0.1-next.67) (2025-06-26)
81
+
82
+
83
+ ### Miscellaneous Chores
84
+
85
+ * **image:** Synchronize repo versions
86
+
87
+
88
+ ### Dependencies
89
+
90
+ * The following workspace dependencies were updated
91
+ * dependencies
92
+ * @twin.org/core bumped from 0.0.1-next.66 to 0.0.1-next.67
93
+
94
+ ## [0.0.1-next.66](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.65...image-v0.0.1-next.66) (2025-06-26)
95
+
96
+
97
+ ### Miscellaneous Chores
98
+
99
+ * **image:** Synchronize repo versions
100
+
101
+
102
+ ### Dependencies
103
+
104
+ * The following workspace dependencies were updated
105
+ * dependencies
106
+ * @twin.org/core bumped from 0.0.1-next.65 to 0.0.1-next.66
107
+
108
+ ## [0.0.1-next.65](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.64...image-v0.0.1-next.65) (2025-06-19)
109
+
110
+
111
+ ### Miscellaneous Chores
112
+
113
+ * **image:** Synchronize repo versions
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/core bumped from 0.0.1-next.64 to 0.0.1-next.65
121
+
122
+ ## [0.0.1-next.64](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.63...image-v0.0.1-next.64) (2025-06-19)
123
+
124
+
125
+ ### Miscellaneous Chores
126
+
127
+ * **image:** Synchronize repo versions
128
+
129
+
130
+ ### Dependencies
131
+
132
+ * The following workspace dependencies were updated
133
+ * dependencies
134
+ * @twin.org/core bumped from 0.0.1-next.63 to 0.0.1-next.64
135
+
136
+ ## [0.0.1-next.63](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.62...image-v0.0.1-next.63) (2025-06-18)
137
+
138
+
139
+ ### Miscellaneous Chores
140
+
141
+ * **image:** Synchronize repo versions
142
+
143
+
144
+ ### Dependencies
145
+
146
+ * The following workspace dependencies were updated
147
+ * dependencies
148
+ * @twin.org/core bumped from 0.0.1-next.62 to 0.0.1-next.63
149
+
150
+ ## [0.0.1-next.62](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.61...image-v0.0.1-next.62) (2025-06-17)
151
+
152
+
153
+ ### Features
154
+
155
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
156
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
157
+
158
+
159
+ ### Dependencies
160
+
161
+ * The following workspace dependencies were updated
162
+ * dependencies
163
+ * @twin.org/core bumped from 0.0.1-next.61 to 0.0.1-next.62
164
+
165
+ ## [0.0.1-next.61](https://github.com/twinfoundation/framework/compare/image-v0.0.1-next.60...image-v0.0.1-next.61) (2025-06-17)
166
+
167
+
168
+ ### Miscellaneous Chores
169
+
170
+ * **image:** Synchronize repo versions
171
+
172
+
173
+ ### Dependencies
174
+
175
+ * The following workspace dependencies were updated
176
+ * dependencies
177
+ * @twin.org/core bumped from 0.0.1-next.60 to 0.0.1-next.61
178
+
179
+ ## [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)
180
+
181
+
182
+ ### Miscellaneous Chores
183
+
184
+ * **image:** Synchronize repo versions
185
+
186
+
187
+ ### Dependencies
188
+
189
+ * The following workspace dependencies were updated
190
+ * dependencies
191
+ * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
192
+
193
+ ## [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)
194
+
195
+
196
+ ### Miscellaneous Chores
197
+
198
+ * **image:** Synchronize repo versions
199
+
200
+
201
+ ### Dependencies
202
+
203
+ * The following workspace dependencies were updated
204
+ * dependencies
205
+ * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
206
+
207
+ ## [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)
208
+
209
+
210
+ ### Miscellaneous Chores
211
+
212
+ * **image:** Synchronize repo versions
213
+
214
+
215
+ ### Dependencies
216
+
217
+ * The following workspace dependencies were updated
218
+ * dependencies
219
+ * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
220
+
221
+ ## [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)
222
+
223
+
224
+ ### Features
225
+
226
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
227
+
228
+
229
+ ### Dependencies
230
+
231
+ * The following workspace dependencies were updated
232
+ * dependencies
233
+ * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
234
+
235
+ ## [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)
236
+
237
+
238
+ ### Miscellaneous Chores
239
+
240
+ * **image:** Synchronize repo versions
241
+
242
+
243
+ ### Dependencies
244
+
245
+ * The following workspace dependencies were updated
246
+ * dependencies
247
+ * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
248
+
249
+ ## [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)
250
+
251
+
252
+ ### Miscellaneous Chores
253
+
254
+ * **image:** Synchronize repo versions
255
+
256
+
257
+ ### Dependencies
258
+
259
+ * The following workspace dependencies were updated
260
+ * dependencies
261
+ * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
262
+
263
+ ## [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)
264
+
265
+
266
+ ### Miscellaneous Chores
267
+
268
+ * **image:** Synchronize repo versions
269
+
270
+
271
+ ### Dependencies
272
+
273
+ * The following workspace dependencies were updated
274
+ * dependencies
275
+ * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
276
+
277
+ ## [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)
278
+
279
+
280
+ ### Miscellaneous Chores
281
+
282
+ * **image:** Synchronize repo versions
283
+
284
+
285
+ ### Dependencies
286
+
287
+ * The following workspace dependencies were updated
288
+ * dependencies
289
+ * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
290
+
291
+ ## [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)
292
+
293
+
294
+ ### Features
295
+
296
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
297
+
298
+
299
+ ### Dependencies
300
+
301
+ * The following workspace dependencies were updated
302
+ * dependencies
303
+ * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
304
+
305
+ ## [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)
306
+
307
+
308
+ ### Miscellaneous Chores
309
+
310
+ * **image:** Synchronize repo versions
311
+
312
+
313
+ ### Dependencies
314
+
315
+ * The following workspace dependencies were updated
316
+ * dependencies
317
+ * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
318
+
319
+ ## [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)
320
+
321
+
322
+ ### Miscellaneous Chores
323
+
324
+ * **image:** Synchronize repo versions
325
+
326
+
327
+ ### Dependencies
328
+
329
+ * The following workspace dependencies were updated
330
+ * dependencies
331
+ * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
332
+
333
+ ## 0.0.1-next.49
4
334
 
5
335
  - Initial Release
@@ -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
 
@@ -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
 
@@ -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.8",
3
+ "version": "0.0.1",
4
4
  "description": "Classes for image manipulation",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,17 +14,17 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.1-next.8",
18
- "@twin.org/nameof": "next"
17
+ "@twin.org/core": "^0.0.1",
18
+ "@twin.org/nameof": "^0.0.1"
19
19
  },
20
20
  "main": "./dist/cjs/index.cjs",
21
21
  "module": "./dist/esm/index.mjs",
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": [