@twin.org/qr 0.0.1-next.1

package/docs/reference/classes/QR.md

@@ -0,0 +1,98 @@
+# Class: QR
+
+Class to generates QR codes from data.
+Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+
+## Constructors
+
+### new QR()
+
+> **new QR**(`typeNumber`, `errorCorrectLevel`): [`QR`](QR.md)
+
+Create a new instance of QR.
+
+#### Parameters
+
+• **typeNumber**: `number` = `6`
+
+0 to 40, 0 means autodetect.
+
+• **errorCorrectLevel**: [`ErrorCorrectLevel`](../type-aliases/ErrorCorrectLevel.md) = `ErrorCorrectLevel.L`
+
+'L','M','Q','H'.
+
+#### Returns
+
+[`QR`](QR.md)
+
+#### Throws
+
+Error if the typeNumber is invalid.
+
+## Methods
+
+### addText()
+
+> **addText**(`qrData`): `void`
+
+Add text data to the QR Code.
+
+#### Parameters
+
+• **qrData**: `string`
+
+The data to add.
+
+#### Returns
+
+`void`
+
+***
+
+### addNumber()
+
+> **addNumber**(`qrData`): `void`
+
+Add number to the QR Code.
+
+#### Parameters
+
+• **qrData**: `string`
+
+The data to add.
+
+#### Returns
+
+`void`
+
+***
+
+### addAlphaNumeric()
+
+> **addAlphaNumeric**(`qrData`): `void`
+
+Add alpha numeric to the QR Code.
+
+#### Parameters
+
+• **qrData**: `string`
+
+The data to add.
+
+#### Returns
+
+`void`
+
+***
+
+### generate()
+
+> **generate**(): [`QRCellData`](../type-aliases/QRCellData.md)
+
+Generate the display buffer.
+
+#### Returns
+
+[`QRCellData`](../type-aliases/QRCellData.md)
+
+Boolean buffer of pixels.

package/docs/reference/classes/TextRenderer.md

@@ -0,0 +1,37 @@
+# Class: TextRenderer
+
+Class to render qr data as text.
+
+## Constructors
+
+### new TextRenderer()
+
+> **new TextRenderer**(): [`TextRenderer`](TextRenderer.md)
+
+#### Returns
+
+[`TextRenderer`](TextRenderer.md)
+
+## Methods
+
+### render()
+
+> `static` **render**(`cellData`, `options`?): `Promise`\<`string`\>
+
+Render the QR code data as text.
+
+#### Parameters
+
+• **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
+
+The cell data for the QR code.
+
+• **options?**: [`ITextRendererOptions`](../interfaces/ITextRendererOptions.md)
+
+The options for rendering.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The text content.

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/qr
+
+## Classes
+
+- [QR](classes/QR.md)
+- [JpegRenderer](classes/JpegRenderer.md)
+- [PngRenderer](classes/PngRenderer.md)
+- [TextRenderer](classes/TextRenderer.md)
+
+## Interfaces
+
+- [IBitmapRendererOptions](interfaces/IBitmapRendererOptions.md)
+- [IRendererOptions](interfaces/IRendererOptions.md)
+- [ITextRendererOptions](interfaces/ITextRendererOptions.md)
+
+## Type Aliases
+
+- [ErrorCorrectLevel](type-aliases/ErrorCorrectLevel.md)
+- [QRCellData](type-aliases/QRCellData.md)
+
+## Variables
+
+- [ErrorCorrectLevel](variables/ErrorCorrectLevel.md)

package/docs/reference/interfaces/IBitmapRendererOptions.md

@@ -0,0 +1,47 @@
+# Interface: IBitmapRendererOptions
+
+Options for rendering.
+
+## Extends
+
+- [`IRendererOptions`](IRendererOptions.md)
+
+## Properties
+
+### background?
+
+> `optional` **background**: `string` \| `Color`
+
+Background color.
+
+***
+
+### foreground?
+
+> `optional` **foreground**: `string` \| `Color`
+
+Foreground color.
+
+***
+
+### cellSize?
+
+> `optional` **cellSize**: `number`
+
+The cell size.
+
+#### Inherited from
+
+[`IRendererOptions`](IRendererOptions.md).[`cellSize`](IRendererOptions.md#cellsize)
+
+***
+
+### marginSize?
+
+> `optional` **marginSize**: `number`
+
+The margin size.
+
+#### Inherited from
+
+[`IRendererOptions`](IRendererOptions.md).[`marginSize`](IRendererOptions.md#marginsize)

package/docs/reference/interfaces/IRendererOptions.md

@@ -0,0 +1,24 @@
+# Interface: IRendererOptions
+
+Options for rendering.
+
+## Extended by
+
+- [`IBitmapRendererOptions`](IBitmapRendererOptions.md)
+- [`ITextRendererOptions`](ITextRendererOptions.md)
+
+## Properties
+
+### cellSize?
+
+> `optional` **cellSize**: `number`
+
+The cell size.
+
+***
+
+### marginSize?
+
+> `optional` **marginSize**: `number`
+
+The margin size.

package/docs/reference/interfaces/ITextRendererOptions.md

@@ -0,0 +1,47 @@
+# Interface: ITextRendererOptions
+
+Options for rendering as text.
+
+## Extends
+
+- [`IRendererOptions`](IRendererOptions.md)
+
+## Properties
+
+### cellSize?
+
+> `optional` **cellSize**: `number`
+
+The cell size.
+
+#### Inherited from
+
+[`IRendererOptions`](IRendererOptions.md).[`cellSize`](IRendererOptions.md#cellsize)
+
+***
+
+### marginSize?
+
+> `optional` **marginSize**: `number`
+
+The margin size.
+
+#### Inherited from
+
+[`IRendererOptions`](IRendererOptions.md).[`marginSize`](IRendererOptions.md#marginsize)
+
+***
+
+### onChar?
+
+> `optional` **onChar**: `string`
+
+The character to use for on pixels.
+
+***
+
+### offChar?
+
+> `optional` **offChar**: `string`
+
+The character to use for off pixels.

package/docs/reference/type-aliases/ErrorCorrectLevel.md

@@ -0,0 +1,6 @@
+# Type Alias: ErrorCorrectLevel
+
+> **ErrorCorrectLevel**: *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\[keyof *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\]
+
+Error correction level to use for the QR Code.
+Based on https://github.com/kazuhikoarase/qrcode-generator/ .

package/docs/reference/type-aliases/QRCellData.md

@@ -0,0 +1,5 @@
+# Type Alias: QRCellData
+
+> **QRCellData**: (`boolean` \| `null`)[][]
+
+Definition of type for QR Code Cell data.

package/docs/reference/variables/ErrorCorrectLevel.md

@@ -0,0 +1,32 @@
+# Variable: ErrorCorrectLevel
+
+> `const` **ErrorCorrectLevel**: `object`
+
+Error correction level to use for the QR Code.
+Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+
+## Type declaration
+
+### L
+
+> `readonly` **L**: `1` = `1`
+
+7% Error correction.
+
+### M
+
+> `readonly` **M**: `0` = `0`
+
+15% Error correction.
+
+### Q
+
+> `readonly` **Q**: `3` = `3`
+
+25% Error correction.
+
+### H
+
+> `readonly` **H**: `2` = `2`
+
+30% Error correction.

package/locales/en.json

@@ -0,0 +1,34 @@
+{
+	"error": {
+		"qr": {
+			"typeNumberRange": "The typeNumber parameter should be a number >= 0 and <= 40, it is {typeNumber}",
+			"dataOverflow": "There is not enough space in the QR code to store the data, {lengthInBits} > {totalDataCount}, try increasing the typeNumber from {typeNumber}, or use 0 for auto detect",
+			"typeNumberOverflow": "There is not enough space in the QR code to store the data, {lengthInBits} > {totalDataCount}, typeNumber cannot be greater than 40"
+		},
+		"rendererOptions": {
+			"cellSizeZero": "The cellSize must be a number > 0, it is \"{cellSize}\"",
+			"marginSizeZero": "The marginSize must be a number >= 0, it is \"{marginSize}\""
+		},
+		"qRAlphaNumeric": {
+			"illegalCharacter ": "Illegal character in string \"{value}\""
+		},
+		"qRNumber": {
+			"illegalCharacter ": "Illegal character in string \"{value}\""
+		},
+		"mathHelper": {
+			"lessThanOne ": "The value can not be less than 1, it is \"{value}\""
+		},
+		"qrHelper": {
+			"correctionLevelRange ": "The errorCorrectLevel parameter should be one of the following: \"L\", \"M\", \"Q\", \"H\", it is \"{errorCorrectLevel}\"",
+			"modeRange ": "The mode parameter should be one of the following: \"Byte\", \"Numeric\", \"Alphanumeric\", it is \"{mode}\"",
+			"maskPatternRange ": "The maskPattern parameter should be a number >= 0 and <= 7, it is \"{maskPattern}\""
+		},
+		"rSBlock": {
+			"correctionLevelRange ": "The errorCorrectLevel parameter should be one of the following: \"L\", \"M\", \"Q\", \"H\", it is \"{errorCorrectLevel}\""
+		},
+		"qRDataBase": {
+			"invalidMode": "Invalid mode {mode} for typeNumber {typeNumber}",
+			"invalidTypeNumber": "Invalid typeNumber {typeNumber}, it should be less than <= 40"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+	"name": "@twin.org/qr",
+	"version": "0.0.1-next.1",
+	"description": "Package for creating QR codes",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/qr"
+	},
+	"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/image": "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"
+	]
+}