@twin.org/image 0.0.3-next.21 → 0.0.3-next.23

package/README.md

@@ -1,9 +1,6 @@
 # TWIN Image
 
-This package contains classes for processing images.
-
-- JpegEncoder
-- PngEncoder
+This package is part of the framework workspace and provides classes for image manipulation to support consistent development workflows across the ecosystem.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,42 @@
-# @twin.org/image - Changelog
+# Changelog
+
+## [0.0.3-next.23](https://github.com/twinfoundation/framework/compare/image-v0.0.3-next.22...image-v0.0.3-next.23) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **image:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof bumped from 0.0.3-next.22 to 0.0.3-next.23
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/validate-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
+
+## [0.0.3-next.22](https://github.com/twinfoundation/framework/compare/image-v0.0.3-next.21...image-v0.0.3-next.22) (2026-02-26)
+
+
+### Miscellaneous Chores
+
+* **image:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/nameof bumped from 0.0.3-next.21 to 0.0.3-next.22
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/validate-locales bumped from 0.0.3-next.21 to 0.0.3-next.22
 
 ## [0.0.3-next.21](https://github.com/twinfoundation/framework/compare/image-v0.0.3-next.20...image-v0.0.3-next.21) (2026-02-26)
 

package/docs/examples.md

@@ -1 +1,48 @@
-# @twin.org/image - Examples
+# Image Examples
+
+Use these snippets for colour handling and image encoding when generating image assets.
+
+## Color
+
+```typescript
+import { Color } from '@twin.org/image';
+
+const accent = Color.fromHex('#4a90e2');
+
+accent.red(); // 74
+accent.green(); // 144
+accent.blue(); // 226
+accent.hexWithAlpha(); // '#ff4a90e2'
+```
+
+## JpegEncoder
+
+```typescript
+import { Color, JpegEncoder } from '@twin.org/image';
+
+const pixels = [
+  [Color.fromHex('#111111'), Color.fromHex('#eeeeee')],
+  [Color.fromHex('#eeeeee'), Color.fromHex('#111111')]
+];
+
+const jpegBytes = JpegEncoder.encode(pixels, {
+  quality: 90
+});
+
+jpegBytes.length > 0; // true
+```
+
+## PngEncoder
+
+```typescript
+import { Color, PngEncoder } from '@twin.org/image';
+
+const pixels = [
+  [Color.fromHex('#ff0000'), Color.fromHex('#00ff00')],
+  [Color.fromHex('#0000ff'), Color.fromHex('#ffffff')]
+];
+
+const pngBytes = PngEncoder.encode(pixels);
+
+pngBytes.length > 0; // true
+```

package/docs/reference/classes/Color.md

@@ -42,7 +42,7 @@ The blue element of the color.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromHex()
+### fromHex() {#fromhex}
 
 > `static` **fromHex**(`hex`): `Color`
 
@@ -76,7 +76,7 @@ Error if the format is incorrect.
 
 ***
 
-### coerce()
+### coerce() {#coerce}
 
 > `static` **coerce**(`value`): `Color` \| `undefined`
 
@@ -98,7 +98,7 @@ The color if one can be created.
 
 ***
 
-### alpha()
+### alpha() {#alpha}
 
 > **alpha**(): `number`
 
@@ -112,7 +112,7 @@ The alpha element.
 
 ***
 
-### red()
+### red() {#red}
 
 > **red**(): `number`
 
@@ -126,7 +126,7 @@ The red element.
 
 ***
 
-### green()
+### green() {#green}
 
 > **green**(): `number`
 
@@ -140,7 +140,7 @@ The green element.
 
 ***
 
-### blue()
+### blue() {#blue}
 
 > **blue**(): `number`
 
@@ -154,7 +154,7 @@ The blue element.
 
 ***
 
-### argb()
+### argb() {#argb}
 
 > **argb**(): `number`
 
@@ -168,7 +168,7 @@ The color as argb.
 
 ***
 
-### rgba()
+### rgba() {#rgba}
 
 > **rgba**(): `number`
 
@@ -182,7 +182,7 @@ The color as rgba.
 
 ***
 
-### rgbText()
+### rgbText() {#rgbtext}
 
 > **rgbText**(): `string`
 
@@ -196,7 +196,7 @@ The color as rgb.
 
 ***
 
-### rgbaText()
+### rgbaText() {#rgbatext}
 
 > **rgbaText**(): `string`
 
@@ -210,7 +210,7 @@ The color as rgba.
 
 ***
 
-### hex()
+### hex() {#hex}
 
 > **hex**(): `string`
 
@@ -224,7 +224,7 @@ The color as hex with no alpha component.
 
 ***
 
-### hexWithAlpha()
+### hexWithAlpha() {#hexwithalpha}
 
 > **hexWithAlpha**(): `string`
 

package/docs/reference/classes/JpegEncoder.md

@@ -17,7 +17,7 @@ Create a new instance of JpegEncoder.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -25,7 +25,7 @@ Runtime name for the class.
 
 ## Methods
 
-### encode()
+### encode() {#encode}
 
 > **encode**(`width`, `height`, `imageData`, `quality`): `Uint8Array`
 

package/docs/reference/classes/PngEncoder.md

@@ -15,7 +15,7 @@ Based on https://github.com/photopea/UPNG.js.
 
 ## Methods
 
-### encode()
+### encode() {#encode}
 
 > **encode**(`buffers`, `w`, `h`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/image",
-	"version": "0.0.3-next.21",
+	"version": "0.0.3-next.23",
 	"description": "Classes for image manipulation",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.3-next.21",
-		"@twin.org/nameof": "0.0.3-next.21"
+		"@twin.org/core": "0.0.3-next.23",
+		"@twin.org/nameof": "0.0.3-next.23"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",