@twin.org/image 0.0.1-next.1

package/dist/types/color.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Class to represent a color.
+ */
+export declare class Color {
+    /**
+     * Create a new instance of color.
+     * @param alpha The alpha element of the color.
+     * @param red The red element of the color.
+     * @param green The green element of the color.
+     * @param blue The blue element of the color.
+     */
+    constructor(alpha: number, red: number, green: number, blue: number);
+    /**
+     * Construct a color from a hex string.
+     * @param hex The hex string to parse.
+     * @returns The color.
+     * @throws Error if the format is incorrect.
+     */
+    static fromHex(hex: string): Color;
+    /**
+     * Coerce an unknown type to a color.
+     * @param value The value to try and convert.
+     * @returns The color if one can be created.
+     */
+    static coerce(value: unknown): Color | undefined;
+    /**
+     * Get the alpha element.
+     * @returns The alpha element.
+     */
+    alpha(): number;
+    /**
+     * Get the red element.
+     * @returns The red element.
+     */
+    red(): number;
+    /**
+     * Get the green element.
+     * @returns The green element.
+     */
+    green(): number;
+    /**
+     * Get the blue element.
+     * @returns The blue element.
+     */
+    blue(): number;
+    /**
+     * Get color as argb.
+     * @returns The color as argb.
+     */
+    argb(): number;
+    /**
+     * Get color as rgba.
+     * @returns The color as rgba.
+     */
+    rgba(): number;
+    /**
+     * Get color as rgb text.
+     * @returns The color as rgb.
+     */
+    rgbText(): string;
+    /**
+     * Get color as rgba text.
+     * @returns The color as rgba.
+     */
+    rgbaText(): string;
+    /**
+     * Get color as hex no alpha.
+     * @returns The color as hex with no alpha component.
+     */
+    hex(): string;
+    /**
+     * Get color as hex with alpha.
+     * @returns The color as hex with with alpha component.
+     */
+    hexWithAlpha(): string;
+}

package/dist/types/encoders/jpegEncoder.d.ts

@@ -0,0 +1,19 @@
+/**
+ * JPEG Encoder.
+ * Based on JPEG encoder ported to JavaScript and optimized by Andreas Ritter.
+ */
+export declare class JpegEncoder {
+    /**
+     * Create a new instance of JpegEncoder.
+     */
+    constructor();
+    /**
+     * Encode the image with the given quality.
+     * @param width The width of the image to encode.
+     * @param height The height of the image to encode.
+     * @param imageData The data for the image.
+     * @param quality The quality to encode the image at.
+     * @returns The data for the encoded image.
+     */
+    encode(width: number, height: number, imageData: Uint8Array, quality: number): Uint8Array;
+}

package/dist/types/encoders/png/frame.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/encoders/png/imageData.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/encoders/png/leaf.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/encoders/pngEncoder.d.ts

@@ -0,0 +1,14 @@
+/**
+ * PNG Encoder.
+ * Based on https://github.com/photopea/UPNG.js.
+ */
+export declare class PngEncoder {
+    /**
+     * Encode the image frames to png.
+     * @param buffers The frame buffers to encode.
+     * @param w The image width.
+     * @param h The image height.
+     * @returns The data for the image.
+     */
+    encode(buffers: ArrayBuffer[], w: number, h: number): Promise<Uint8Array>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./color";
+export * from "./encoders/jpegEncoder";
+export * from "./encoders/pngEncoder";

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/image - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/image - Examples

package/docs/reference/classes/Color.md

@@ -0,0 +1,217 @@
+# Class: Color
+
+Class to represent a color.
+
+## Constructors
+
+### new Color()
+
+> **new Color**(`alpha`, `red`, `green`, `blue`): [`Color`](Color.md)
+
+Create a new instance of color.
+
+#### Parameters
+
+• **alpha**: `number`
+
+The alpha element of the color.
+
+• **red**: `number`
+
+The red element of the color.
+
+• **green**: `number`
+
+The green element of the color.
+
+• **blue**: `number`
+
+The blue element of the color.
+
+#### Returns
+
+[`Color`](Color.md)
+
+## Methods
+
+### fromHex()
+
+> `static` **fromHex**(`hex`): [`Color`](Color.md)
+
+Construct a color from a hex string.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex string to parse.
+
+#### Returns
+
+[`Color`](Color.md)
+
+The color.
+
+#### Throws
+
+Error if the format is incorrect.
+
+***
+
+### coerce()
+
+> `static` **coerce**(`value`): `undefined` \| [`Color`](Color.md)
+
+Coerce an unknown type to a color.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to try and convert.
+
+#### Returns
+
+`undefined` \| [`Color`](Color.md)
+
+The color if one can be created.
+
+***
+
+### alpha()
+
+> **alpha**(): `number`
+
+Get the alpha element.
+
+#### Returns
+
+`number`
+
+The alpha element.
+
+***
+
+### red()
+
+> **red**(): `number`
+
+Get the red element.
+
+#### Returns
+
+`number`
+
+The red element.
+
+***
+
+### green()
+
+> **green**(): `number`
+
+Get the green element.
+
+#### Returns
+
+`number`
+
+The green element.
+
+***
+
+### blue()
+
+> **blue**(): `number`
+
+Get the blue element.
+
+#### Returns
+
+`number`
+
+The blue element.
+
+***
+
+### argb()
+
+> **argb**(): `number`
+
+Get color as argb.
+
+#### Returns
+
+`number`
+
+The color as argb.
+
+***
+
+### rgba()
+
+> **rgba**(): `number`
+
+Get color as rgba.
+
+#### Returns
+
+`number`
+
+The color as rgba.
+
+***
+
+### rgbText()
+
+> **rgbText**(): `string`
+
+Get color as rgb text.
+
+#### Returns
+
+`string`
+
+The color as rgb.
+
+***
+
+### rgbaText()
+
+> **rgbaText**(): `string`
+
+Get color as rgba text.
+
+#### Returns
+
+`string`
+
+The color as rgba.
+
+***
+
+### hex()
+
+> **hex**(): `string`
+
+Get color as hex no alpha.
+
+#### Returns
+
+`string`
+
+The color as hex with no alpha component.
+
+***
+
+### hexWithAlpha()
+
+> **hexWithAlpha**(): `string`
+
+Get color as hex with alpha.
+
+#### Returns
+
+`string`
+
+The color as hex with with alpha component.

package/docs/reference/classes/JpegEncoder.md

@@ -0,0 +1,48 @@
+# Class: JpegEncoder
+
+JPEG Encoder.
+Based on JPEG encoder ported to JavaScript and optimized by Andreas Ritter.
+
+## Constructors
+
+### new JpegEncoder()
+
+> **new JpegEncoder**(): [`JpegEncoder`](JpegEncoder.md)
+
+Create a new instance of JpegEncoder.
+
+#### Returns
+
+[`JpegEncoder`](JpegEncoder.md)
+
+## Methods
+
+### encode()
+
+> **encode**(`width`, `height`, `imageData`, `quality`): `Uint8Array`
+
+Encode the image with the given quality.
+
+#### Parameters
+
+• **width**: `number`
+
+The width of the image to encode.
+
+• **height**: `number`
+
+The height of the image to encode.
+
+• **imageData**: `Uint8Array`
+
+The data for the image.
+
+• **quality**: `number`
+
+The quality to encode the image at.
+
+#### Returns
+
+`Uint8Array`
+
+The data for the encoded image.

package/docs/reference/classes/PngEncoder.md

@@ -0,0 +1,42 @@
+# Class: PngEncoder
+
+PNG Encoder.
+Based on https://github.com/photopea/UPNG.js.
+
+## Constructors
+
+### new PngEncoder()
+
+> **new PngEncoder**(): [`PngEncoder`](PngEncoder.md)
+
+#### Returns
+
+[`PngEncoder`](PngEncoder.md)
+
+## Methods
+
+### encode()
+
+> **encode**(`buffers`, `w`, `h`): `Promise`\<`Uint8Array`\>
+
+Encode the image frames to png.
+
+#### Parameters
+
+• **buffers**: `ArrayBuffer`[]
+
+The frame buffers to encode.
+
+• **w**: `number`
+
+The image width.
+
+• **h**: `number`
+
+The image height.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The data for the image.

package/docs/reference/index.md

@@ -0,0 +1,7 @@
+# @twin.org/image
+
+## Classes
+
+- [Color](classes/Color.md)
+- [JpegEncoder](classes/JpegEncoder.md)
+- [PngEncoder](classes/PngEncoder.md)

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"error": {
+		"jpegEncoder": {
+			"invalidQuality": "Quality must be between 1 and 100, it is \"{value}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "@twin.org/image",
+	"version": "0.0.1-next.1",
+	"description": "Classes for image manipulation",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/image"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "0.0.1-next.1",
+		"@twin.org/nameof": "next"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}