Added TypeScript port of the library.

Readme.markdown

@@ -15,10 +15,10 @@ Features
 
 Core features:
 
-* Available in 6 programming languages, all with nearly equal functionality: Java, JavaScript, Python, C++, C, Rust
+* Available in 7 programming languages, all with nearly equal functionality: Java, JavaScript, TypeScript, Python, C++, C, Rust
 * Significantly shorter code but more documentation comments compared to competing libraries
 * Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
-* Output formats: Raw modules/pixels of the QR symbol (all languages), SVG XML string (all languages except C), `BufferedImage` raster bitmap (Java only), HTML5 canvas (JavaScript only)
+* Output formats: Raw modules/pixels of the QR symbol (all languages), SVG XML string (all languages except C), `BufferedImage` raster bitmap (Java only), HTML5 canvas (JavaScript and TypeScript only)
 * Encodes numeric and special-alphanumeric text in less space than general text
 * Open source code under the permissive MIT License
 
@@ -79,6 +79,24 @@ JavaScript language:
         }
     }
 
+TypeScript language:
+
+    // Simple operation
+    let qr0: qrcodegen.QrCode = qrcodegen.QrCode.encodeText(
+        "Hello, world!", qrcodegen.QrCode_Ecc.MEDIUM);
+    let svg: string = qr0.toSvgString(4);
+    
+    // Manual operation
+    let segs: Array<qrcodegen.QrSegment> =
+        qrcodegen.QrSegment.makeSegments("3141592653589793238462643383");
+    let qr1: qrcodegen.QrCode = qrcodegen.QrCode.encodeSegments(
+        segs, qrcodegen.QrCode_Ecc.HIGH, 5, 5, 2, false);
+    for (let y = 0; y < qr1.size; y++) {
+        for (let x = 0; x < qr1.size; x++) {
+            (... paint qr1.getModule(x, y) ...)
+        }
+    }
+
 Python language:
 
     from qrcodegen import *

typescript/qrcodegen-demo.ts

@@ -0,0 +1,180 @@
+/* 
+ * QR Code generator demo (TypeScript)
+ * 
+ * Copyright (c) Project Nayuki. (MIT License)
+ * https://www.nayuki.io/page/qr-code-generator-library
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ * - The above copyright notice and this permission notice shall be included in
+ *   all copies or substantial portions of the Software.
+ * - The Software is provided "as is", without warranty of any kind, express or
+ *   implied, including but not limited to the warranties of merchantability,
+ *   fitness for a particular purpose and noninfringement. In no event shall the
+ *   authors or copyright holders be liable for any claim, damages or other
+ *   liability, whether in an action of contract, tort or otherwise, arising from,
+ *   out of or in connection with the Software or the use or other dealings in the
+ *   Software.
+ */
+
+"use strict";
+
+
+{
+	const myWindow = window as any;
+	
+	
+	/*---- Functions called from HTML code ----*/
+	
+	myWindow.redrawQrCode = (): void => {
+		// Show/hide rows based on bitmap/vector image output
+		const bitmapOutput: boolean = getInput("output-format-bitmap").checked;
+		const scaleRow : HTMLElement = getElem("scale-row");
+		const svgXmlRow: HTMLElement = getElem("svg-xml-row");
+		if (bitmapOutput) {
+			scaleRow.style.removeProperty("display");
+			svgXmlRow.style.display = "none";
+		} else {
+			scaleRow.style.display = "none";
+			svgXmlRow.style.removeProperty("display");
+		}
+		const svgXml = getElem("svg-xml-output") as HTMLTextAreaElement;
+		svgXml.value = "";
+		
+		// Reset output images in case of early termination
+		const canvas = getElem("qrcode-canvas") as HTMLCanvasElement;
+		const svg = (document.getElementById("qrcode-svg") as Element) as SVGElement;
+		canvas.style.display = "none";
+		svg.style.display = "none";
+		
+		// Returns a QrCode.Ecc object based on the radio buttons in the HTML form.
+		function getInputErrorCorrectionLevel(): qrcodegen.QrCode_Ecc {
+			if (getInput("errcorlvl-medium").checked)
+				return qrcodegen.QrCode_Ecc.MEDIUM;
+			else if (getInput("errcorlvl-quartile").checked)
+				return qrcodegen.QrCode_Ecc.QUARTILE;
+			else if (getInput("errcorlvl-high").checked)
+				return qrcodegen.QrCode_Ecc.HIGH;
+			else  // In case no radio button is depressed
+				return qrcodegen.QrCode_Ecc.LOW;
+		}
+		
+		// Get form inputs and compute QR Code
+		const ecl: qrcodegen.QrCode_Ecc = getInputErrorCorrectionLevel();
+		const text: string = (getElem("text-input") as HTMLTextAreaElement).value;
+		const segs: Array<qrcodegen.QrSegment> = qrcodegen.QrSegment.makeSegments(text);
+		const minVer: number = parseInt(getInput("version-min-input").value, 10);
+		const maxVer: number = parseInt(getInput("version-max-input").value, 10);
+		const mask: number = parseInt(getInput("mask-input").value, 10);
+		const boostEcc: boolean = getInput("boost-ecc-input").checked;
+		const qr: qrcodegen.QrCode = qrcodegen.QrCode.encodeSegments(segs, ecl, minVer, maxVer, mask, boostEcc);
+		
+		// Draw image output
+		const border: number = parseInt(getInput("border-input").value, 10);
+		if (border < 0 || border > 100)
+			return;
+		if (bitmapOutput) {
+			const scale: number = parseInt(getInput("scale-input").value, 10);
+			if (scale <= 0 || scale > 30)
+				return;
+			qr.drawCanvas(scale, border, canvas);
+			canvas.style.removeProperty("display");
+		} else {
+			const code: string = qr.toSvgString(border);
+			const viewBox: string = (/ viewBox="([^"]*)"/.exec(code) as RegExpExecArray)[1];
+			const pathD: string = (/ d="([^"]*)"/.exec(code) as RegExpExecArray)[1];
+			svg.setAttribute("viewBox", viewBox);
+			(svg.querySelector("path") as Element).setAttribute("d", pathD);
+			svg.style.removeProperty("display");
+			svgXml.value = qr.toSvgString(border);
+		}
+		
+		// Returns a string to describe the given list of segments.
+		function describeSegments(segs: Array<qrcodegen.QrSegment>): string {
+			if (segs.length == 0)
+				return "none";
+			else if (segs.length == 1) {
+				const mode: qrcodegen.QrSegment_Mode = segs[0].mode;
+				const Mode = qrcodegen.QrSegment_Mode;
+				if (mode == Mode.NUMERIC     )  return "numeric";
+				if (mode == Mode.ALPHANUMERIC)  return "alphanumeric";
+				if (mode == Mode.BYTE        )  return "byte";
+				if (mode == Mode.KANJI       )  return "kanji";
+				return "unknown";
+			} else
+				return "multiple";
+		}
+		
+		// Returns the number of Unicode code points in the given UTF-16 string.
+		function countUnicodeChars(str: string): number {
+			let result: number = 0;
+			for (let i = 0; i < str.length; i++, result++) {
+				const c: number = str.charCodeAt(i);
+				if (c < 0xD800 || c >= 0xE000)
+					continue;
+				else if (0xD800 <= c && c < 0xDC00 && i + 1 < str.length) {  // High surrogate
+					i++;
+					const d: number = str.charCodeAt(i);
+					if (0xDC00 <= d && d < 0xE000)  // Low surrogate
+						continue;
+				}
+				throw "Invalid UTF-16 string";
+			}
+			return result;
+		}
+		
+		// Show the QR Code symbol's statistics as a string
+		getElem("statistics-output").textContent = `QR Code version = ${qr.version}, ` +
+			`mask pattern = ${qr.mask}, ` +
+			`character count = ${countUnicodeChars(text)},\n` +
+			`encoding mode = ${describeSegments(segs)}, ` +
+			`error correction = level ${"LMQH".charAt(qr.errorCorrectionLevel.ordinal)}, ` +
+			`data bits = ${qrcodegen.QrSegment.getTotalBits(segs, qr.version) as number}.`;
+	}
+	
+	
+	myWindow.handleVersionMinMax = (which: "min"|"max"): void => {
+		const minElem: HTMLInputElement = getInput("version-min-input");
+		const maxElem: HTMLInputElement = getInput("version-max-input");
+		let minVal: number = parseInt(minElem.value, 10);
+		let maxVal: number = parseInt(maxElem.value, 10);
+		minVal = Math.max(Math.min(minVal, qrcodegen.QrCode.MAX_VERSION), qrcodegen.QrCode.MIN_VERSION);
+		maxVal = Math.max(Math.min(maxVal, qrcodegen.QrCode.MAX_VERSION), qrcodegen.QrCode.MIN_VERSION);
+		if (which == "min" && minVal > maxVal)
+			maxVal = minVal;
+		else if (which == "max" && maxVal < minVal)
+			minVal = maxVal;
+		minElem.value = minVal.toString();
+		maxElem.value = maxVal.toString();
+		myWindow.redrawQrCode();
+	}
+	
+	
+	
+	/*---- Private helper functions ----*/
+	
+	function getElem(id: string): HTMLElement {
+		const result: HTMLElement|null = document.getElementById(id);
+		if (result instanceof HTMLElement)
+			return result;
+		throw "Assertion error";
+	}
+	
+	
+	function getInput(id: string): HTMLInputElement {
+		const result: HTMLElement = getElem(id);
+		if (result instanceof HTMLInputElement)
+			return result;
+		throw "Assertion error";
+	}
+	
+	
+	
+	/*---- Initialization ----*/
+	
+	myWindow.redrawQrCode();
+}

typescript/qrcodegen-js-demo.html

@@ -0,0 +1,121 @@
+<!--
+  - QR Code generator demo (HTML+TypeScript)
+  - 
+  - Copyright (c) Project Nayuki. (MIT License)
+  - https://www.nayuki.io/page/qr-code-generator-library
+  - 
+  - Permission is hereby granted, free of charge, to any person obtaining a copy of
+  - this software and associated documentation files (the "Software"), to deal in
+  - the Software without restriction, including without limitation the rights to
+  - use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+  - the Software, and to permit persons to whom the Software is furnished to do so,
+  - subject to the following conditions:
+  - * The above copyright notice and this permission notice shall be included in
+  -   all copies or substantial portions of the Software.
+  - * The Software is provided "as is", without warranty of any kind, express or
+  -   implied, including but not limited to the warranties of merchantability,
+  -   fitness for a particular purpose and noninfringement. In no event shall the
+  -   authors or copyright holders be liable for any claim, damages or other
+  -   liability, whether in an action of contract, tort or otherwise, arising from,
+  -   out of or in connection with the Software or the use or other dealings in the
+  -   Software.
+  -->
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="UTF-8">
+	<title>QR Code generator library demo (TypeScript)</title>
+	<style type="text/css">
+	html {
+		font-family: sans-serif;
+	}
+	td {
+		vertical-align: top;
+		padding-top: 0.2em;
+		padding-bottom: 0.2em;
+	}
+	td:first-child {
+		white-space: pre;
+	}
+	input[type=radio] + label, input[type=checkbox] + label {
+		margin-left: 0.1em;
+		margin-right: 0.7em;
+	}
+	</style>
+</head>
+
+<body>
+<h1>QR Code generator demo library (TypeScript)</h1>
+<form action="#" method="get" onsubmit="return false;">
+	<table class="noborder" style="width:100%">
+		<tbody>
+			<tr>
+				<td><strong>Text string:</strong></td>
+				<td style="width:100%"><textarea placeholder="Enter your text to be put into the QR Code" id="text-input" style="width:100%; max-width:30em; height:5em; font-family:inherit" oninput="redrawQrCode();"></textarea></td>
+			</tr>
+			<tr>
+				<td><strong>QR Code:</strong></td>
+				<td>
+					<canvas id="qrcode-canvas" style="padding:1em; background-color:#E8E8E8"></canvas>
+					<svg id="qrcode-svg" style="width:30em; height:30em; padding:1em; background-color:#E8E8E8">
+						<rect width="100%" height="100%" fill="#FFFFFF" stroke-width="0"></rect>
+						<path d="" fill="#000000" stroke-width="0"></path>
+					</svg>
+				</td>
+			</tr>
+			<tr>
+				<td><strong>Error correction:</strong></td>
+				<td>
+					<input type="radio" name="errcorlvl" id="errcorlvl-low" onchange="redrawQrCode();" checked="checked"><label for="errcorlvl-low">Low</label>
+					<input type="radio" name="errcorlvl" id="errcorlvl-medium" onchange="redrawQrCode();"><label for="errcorlvl-medium">Medium</label>
+					<input type="radio" name="errcorlvl" id="errcorlvl-quartile" onchange="redrawQrCode();"><label for="errcorlvl-quartile">Quartile</label>
+					<input type="radio" name="errcorlvl" id="errcorlvl-high" onchange="redrawQrCode();"><label for="errcorlvl-high">High</label>
+				</td>
+			</tr>
+			<tr>
+				<td>Output format:</td>
+				<td>
+					<input type="radio" name="output-format" id="output-format-bitmap" onchange="redrawQrCode();" checked="checked"><label for="output-format-bitmap">Bitmap</label>
+					<input type="radio" name="output-format" id="output-format-vector" onchange="redrawQrCode();"><label for="output-format-vector">Vector</label>
+				</td>
+			</tr>
+			<tr>
+				<td>Border:</td>
+				<td><input type="number" value="4" min="0" max="100" step="1" id="border-input" style="width:4em" oninput="redrawQrCode();"> modules</td>
+			</tr>
+			<tr id="scale-row">
+				<td>Scale:</td>
+				<td><input type="number" value="8" min="1" max="30" step="1" id="scale-input" style="width:4em" oninput="redrawQrCode();"> pixels per module</td>
+			</tr>
+			<tr>
+				<td>Version range:</td>
+				<td>Minimum = <input type="number" value="1" min="1" max="40" step="1" id="version-min-input" style="width:4em" oninput="handleVersionMinMax('min');">, maximum = <input type="number" value="40" min="1" max="40" step="1" id="version-max-input" style="width:4em" oninput="handleVersionMinMax('max');"></td>
+			</tr>
+			<tr>
+				<td>Mask pattern:</td>
+				<td><input type="number" value="-1" min="-1" max="7" step="1" id="mask-input" style="width:4em" oninput="redrawQrCode();"> (−1 for automatic, 0 to 7 for manual)</td>
+			</tr>
+			<tr>
+				<td>Boost ECC:</td>
+				<td><input type="checkbox" checked="checked" id="boost-ecc-input" onchange="redrawQrCode();"><label for="boost-ecc-input">Increase <abbr title="error-correcting code">ECC</abbr> level within same version</label></td>
+			</tr>
+			<tr>
+				<td>Statistics:</td>
+				<td id="statistics-output" style="white-space:pre"></td>
+			</tr>
+			<tr id="svg-xml-row">
+				<td>SVG XML code:</td>
+				<td>
+					<textarea id="svg-xml-output" readonly="readonly" style="width:100%; max-width:50em; height:15em; font-family:monospace"></textarea>
+				</td>
+			</tr>
+		</tbody>
+	</table>
+</form>
+<script type="application/javascript" src="qrcodegen.js"></script>
+<script type="application/javascript" src="qrcodegen-demo.js"></script>
+
+<hr>
+<p>Copyright © Project Nayuki – <a href="https://www.nayuki.io/page/qr-code-generator-library">https://www.nayuki.io/page/qr-code-generator-library</a></p>
+</body>
+</html>