js-draw 0.25.0 → 1.0.0

package/src/Color4.ts

@@ -1,304 +0,0 @@
-import Vec3 from './math/Vec3';
-
-export default class Color4 {
-	private constructor(
-		/** Red component. Should be in the range [0, 1]. */
-		public readonly r: number,
-
-		/** Green component. `g` ∈ [0, 1] */
-		public readonly g: number,
-
-		/** Blue component. `b` ∈ [0, 1] */
-		public readonly b: number,
-
-		/** Alpha/transparent component. `a` ∈ [0, 1]. 0 = transparent */
-		public readonly a: number
-	) {
-	}
-
-	/**
-	 * Create a color from red, green, blue components. The color is fully opaque (`a = 1.0`).
-	 *
-	 * Each component should be in the range [0, 1].
-	 */
-	public static ofRGB(red: number, green: number, blue: number): Color4 {
-		return Color4.ofRGBA(red, green, blue, 1.0);
-	}
-
-	public static ofRGBA(red: number, green: number, blue: number, alpha: number): Color4 {
-		red = Math.max(0, Math.min(red, 1));
-		green = Math.max(0, Math.min(green, 1));
-		blue = Math.max(0, Math.min(blue, 1));
-		alpha = Math.max(0, Math.min(alpha, 1));
-
-		return new Color4(red, green, blue, alpha);
-	}
-
-	public static fromHex(hexString: string): Color4 {
-		// Remove starting '#' (if present)
-		hexString = (hexString.match(/^[#]?(.*)$/) ?? [])[1];
-		hexString = hexString.toUpperCase();
-
-		if (!hexString.match(/^[0-9A-F]+$/)) {
-			throw new Error(`${hexString} is not in a valid format.`);
-		}
-
-		// RGBA or RGB
-		if (hexString.length === 3 || hexString.length === 4) {
-			// Each character is a component
-			const components = hexString.split('');
-
-			// Convert to RRGGBBAA or RRGGBB format
-			hexString = components.map(component => `${component}0`).join('');
-		}
-
-		if (hexString.length === 6) {
-			// Alpha component
-			hexString += 'FF';
-		}
-
-		const components: number[] = [];
-		for (let i = 2; i <= hexString.length; i += 2) {
-			const chunk = hexString.substring(i - 2, i);
-			components.push(parseInt(chunk, 16) / 255);
-		}
-
-		if (components.length !== 4) {
-			throw new Error(`Unable to parse ${hexString}: Wrong number of components.`);
-		}
-
-		return Color4.ofRGBA(components[0], components[1], components[2], components[3]);
-	}
-
-	/** Like fromHex, but can handle additional colors if an `HTMLCanvasElement` is available. */
-	public static fromString(text: string): Color4 {
-		if (text.startsWith('#')) {
-			return Color4.fromHex(text);
-		}
-
-		if (text === 'none' || text === 'transparent') {
-			return Color4.transparent;
-		}
-
-		// rgba?: Match both rgb and rgba strings.
-		// ([,0-9.]+): Match any string of only numeric, '.' and ',' characters.
-		const rgbRegex = /^rgba?\(([,0-9.]+)\)$/i;
-		const rgbMatch = text.replace(/\s*/g, '').match(rgbRegex);
-
-		if (rgbMatch) {
-			const componentsListStr = rgbMatch[1];
-			const componentsList = JSON.parse(`[ ${componentsListStr} ]`);
-
-			if (componentsList.length === 3) {
-				return Color4.ofRGB(
-					componentsList[0] / 255, componentsList[1] / 255, componentsList[2] / 255
-				);
-			} else if (componentsList.length === 4) {
-				return Color4.ofRGBA(
-					componentsList[0] / 255, componentsList[1] / 255, componentsList[2] / 255, componentsList[3]
-				);
-			} else {
-				throw new Error(`RGB string, ${text}, has wrong number of components: ${componentsList.length}`);
-			}
-		}
-
-		// Otherwise, try to use an HTMLCanvasElement to determine the color.
-		// Note: We may be unable to create an HTMLCanvasElement if running as a unit test.
-		const canvas = document.createElement('canvas');
-		canvas.width = 1;
-		canvas.height = 1;
-
-		const ctx = canvas.getContext('2d')!;
-		ctx.fillStyle = text;
-		ctx.fillRect(0, 0, 1, 1);
-
-		const data = ctx.getImageData(0, 0, 1, 1);
-		const red = data.data[0] / 255;
-		const green = data.data[1] / 255;
-		const blue = data.data[2] / 255;
-		const alpha = data.data[3] / 255;
-
-		return Color4.ofRGBA(red, green, blue, alpha);
-	}
-
-	/** @returns true if `this` and `other` are approximately equal. */
-	public eq(other: Color4|null|undefined): boolean {
-		if (other == null) {
-			return false;
-		}
-
-		// If both completely transparent,
-		if (this.a === 0 && other.a === 0) {
-			return true;
-		}
-
-		return this.toHexString() === other.toHexString();
-	}
-
-	/**
-	 * If `fractionTo` is not in the range [0, 1], it will be clamped to the nearest number
-	 * in that range. For example, `a.mix(b, -1)` is equivalent to `a.mix(b, 0)`.
-	 *
-	 * @returns a color `fractionTo` of the way from this color to `other`.
-	 *
-	 * @example
-	 * ```ts
-	 * Color4.ofRGB(1, 0, 0).mix(Color4.ofRGB(0, 1, 0), 0.1) // -> Color4(0.9, 0.1, 0)
-	 * ```
-	 */
-	public mix(other: Color4, fractionTo: number): Color4 {
-		fractionTo = Math.min(Math.max(fractionTo, 0), 1);
-		const fractionOfThis = 1 - fractionTo;
-		return new Color4(
-			this.r * fractionOfThis + other.r * fractionTo,
-			this.g * fractionOfThis + other.g * fractionTo,
-			this.b * fractionOfThis + other.b * fractionTo,
-			this.a * fractionOfThis + other.a * fractionTo,
-		);
-	}
-
-	/**
-	 * @returns the component-wise average of `colors`, or `Color4.transparent` if `colors` is empty.
-	 */
-	public static average(colors: Color4[]) {
-		let averageA = 0;
-		let averageR = 0;
-		let averageG = 0;
-		let averageB = 0;
-
-		for (const color of colors) {
-			averageA += color.a;
-			averageR += color.r;
-			averageG += color.g;
-			averageB += color.b;
-		}
-
-		if (colors.length > 0) {
-			averageA /= colors.length;
-			averageR /= colors.length;
-			averageG /= colors.length;
-			averageB /= colors.length;
-		}
-
-		return new Color4(averageR, averageG, averageB, averageA);
-	}
-
-	/**
-	 * Converts to (hue, saturation, value).
-	 * See also https://en.wikipedia.org/wiki/HSL_and_HSV#General_approach
-	 *
-	 * The resultant hue is represented in radians and is thus in [0, 2pi].
-	 */
-	public asHSV(): Vec3 {
-		// Ref: https://en.wikipedia.org/wiki/HSL_and_HSV#General_approach
-		//
-		// HUE:
-		// First, consider the unit cube. Rotate it such that one vertex is at the origin
-		// of a plane and its three neighboring vertices are equidistant from that plane:
-		//
-		//         /\
-		//       /  | \
-		//   2 /    3   \ 1
-		//     \    |   /
-		//       \  | /
-		//   .     \/      .
-		//
-		//        .
-		//
-		// Let z be up and (x, y, 0) be in the plane.
-		//
-		// Label vectors 1,2,3 with R, G, and B, respectively. Let R's projection into the plane
-		// lie along the x axis.
-		//
-		// Because R is a unit vector and R, G, B are equidistant from the plane, they must
-		// form 30-60-90 triangles, which have side lengths proportional to (1, √3, 2)
-		//
-		//       /|
-		//    1/  | (√3)/2
-		//    /   |
-		//      1/2
-		//
-		const minComponent = Math.min(this.r, this.g, this.b);
-		const maxComponent = Math.max(this.r, this.g, this.b);
-		const chroma = maxComponent - minComponent;
-
-		let hue;
-
-		// See https://en.wikipedia.org/wiki/HSL_and_HSV#General_approach
-		if (chroma === 0) {
-			hue = 0;
-		} else if (this.r >= this.g && this.r >= this.b) {
-			hue = ((this.g - this.b) / chroma) % 6;
-		} else if (this.g >= this.r && this.g >= this.b) {
-			hue = (this.b - this.r) / chroma + 2;
-		} else {
-			hue = (this.r - this.g) / chroma + 4;
-		}
-
-		// Convert to degree representation, then to radians.
-		hue *= 60;
-		hue *= Math.PI / 180;
-
-		// Ensure positivity.
-		if (hue < 0) {
-			hue += Math.PI * 2;
-		}
-
-		const value = maxComponent;
-		const saturation = value > 0 ? chroma / value : 0;
-
-		return Vec3.of(hue, saturation, value);
-	}
-
-	private hexString: string|null = null;
-
-	/**
-	 * @returns a hexadecimal color string representation of `this`, in the form `#rrggbbaa`.
-	 *
-	 * @example
-	 * ```
-	 * Color4.red.toHexString(); // -> #ff0000ff
-	 * ```
-	 */
-	public toHexString(): string {
-		if (this.hexString) {
-			return this.hexString;
-		}
-
-		const componentToHex = (component: number): string => {
-			const res = Math.round(255 * component).toString(16);
-
-			if (res.length === 1) {
-				return `0${res}`;
-			}
-			return res;
-		};
-
-		const alpha = componentToHex(this.a);
-		const red = componentToHex(this.r);
-		const green = componentToHex(this.g);
-		const blue = componentToHex(this.b);
-		if (alpha === 'ff') {
-			return `#${red}${green}${blue}`;
-		}
-		this.hexString = `#${red}${green}${blue}${alpha}`;
-		return this.hexString;
-	}
-
-	public toString() {
-		return this.toHexString();
-	}
-
-	public static transparent = Color4.ofRGBA(0, 0, 0, 0);
-	public static red = Color4.ofRGB(1.0, 0.0, 0.0);
-	public static green = Color4.ofRGB(0.0, 1.0, 0.0);
-	public static blue = Color4.ofRGB(0.0, 0.0, 1.0);
-	public static purple = Color4.ofRGB(0.5, 0.2, 0.5);
-	public static yellow = Color4.ofRGB(1, 1, 0.1);
-	public static clay = Color4.ofRGB(0.8, 0.4, 0.2);
-	public static black = Color4.ofRGB(0, 0, 0);
-	public static gray = Color4.ofRGB(0.5, 0.5, 0.5);
-	public static white = Color4.ofRGB(1, 1, 1);
-}
-
-export { Color4 };

package/src/Editor.css

@@ -1,98 +0,0 @@
-
-@import url('./toolbar/toolbar.css');
-@import url('./tools/tools.css');
-@import url('./Coloris.css');
-
-.imageEditorContainer {
-	/* Deafult colors for the editor */
-    --primary-background-color: white;
-    --primary-background-color-transparent: rgba(255, 255, 255, 0.5);
-    --secondary-background-color: #faf;
-    --primary-foreground-color: black;
-    --secondary-foreground-color: black;
-	--primary-shadow-color: rgba(0, 0, 0, 0.5);
-}
-
-@media (prefers-color-scheme: dark) {
-	.imageEditorContainer {
-		--primary-background-color: #151515;
-		--primary-background-color-transparent: rgba(50, 50, 50, 0.5);
-		--secondary-background-color: #607;
-		--primary-foreground-color: white;
-		--secondary-foreground-color: white;
-		--primary-shadow-color: rgba(250, 250, 250, 0.5);
-	}
-}
-
-.imageEditorContainer {
-	color: var(--primary-foreground-color);
-	font-family: system-ui, -apple-system, sans-serif;
-	background-color: var(--primary-background-color);
-
-	display: flex;
-	flex-direction: column-reverse;
-}
-
-.imageEditorContainer .imageEditorRenderArea {
-	display: grid;
-	grid-template-columns: 1fr;
-	flex-grow: 2;
-	flex-shrink: 1;
-	min-height: 100px;
-}
-
-.imageEditorContainer .imageEditorRenderArea canvas {
-	/* Stack all canvases on top of each other */
-	grid-row: 1 / 1;
-	grid-column: 1 / 1;
-	touch-action: none;
-
-	/* Fill the container */
-	box-sizing: border-box;
-	width: 100%;
-	height: 100%;
-
-	/* Allow the canvas to shrink (needed in Chrome) */
-	min-height: 0px;
-	max-height: inherit;
-}
-
-.imageEditorContainer .loadingMessage {
-	position: fixed;
-	text-align: center;
-	font-size: 2em;
-
-	bottom: 0;
-	left: 0;
-	right: 0;
-}
-
-.imageEditorContainer .accessibilityAnnouncement {
-	opacity: 0;
-	width: 0;
-	height: 0;
-	overflow: hidden;
-	pointer-events: none;
-}
-
-.imageEditorContainer .textRendererOutputContainer {
-	width: 1px;
-	height: 1px;
-	overflow: hidden;
-}
-
-.imageEditorContainer .textRendererOutputContainer:focus-within {
-	overflow: visible;
-	z-index: 5;
-}
-
-@media print {
-	.imageEditorContainer .loadingMessage {
-		display: none;
-	}
-
-	.imageEditorContainer .imageEditorRenderArea canvas {
-		width: 100%;
-		height: initial;
-	}
-}

package/src/Editor.loadFrom.test.ts

@@ -1,24 +0,0 @@
-import Color4 from './Color4';
-import { imageBackgroundCSSClassName } from './components/BackgroundComponent';
-import { RestyleableComponent } from './lib';
-import SVGLoader from './SVGLoader';
-import createEditor from './testing/createEditor';
-
-describe('Editor.loadFrom', () => {
-	it('should remove existing BackgroundComponents when loading new BackgroundComponents', async () => {
-		const editor = createEditor();
-		await editor.dispatch(editor.setBackgroundColor(Color4.red));
-
-		let backgroundComponents = editor.image.getBackgroundComponents();
-		expect(backgroundComponents).toHaveLength(1);
-		expect((backgroundComponents[0] as RestyleableComponent).getStyle().color).objEq(Color4.red);
-
-		await editor.loadFrom(SVGLoader.fromString(`<svg viewBox='0 0 100 100'>
-			<path class='${imageBackgroundCSSClassName}' d='m0,0 L100,0 L100,100 L0,100 z' fill='#000'/>
-		</svg>`, true));
-
-		backgroundComponents = editor.image.getBackgroundComponents();
-		expect(backgroundComponents).toHaveLength(1);
-		expect((backgroundComponents[0] as RestyleableComponent).getStyle().color).objEq(Color4.black);
-	});
-});

package/src/Editor.toSVG.test.ts

@@ -1,111 +0,0 @@
-import { Color4, Mat33, Rect2, TextComponent, EditorImage, Vec2 } from './lib';
-import TextRenderingStyle from './rendering/TextRenderingStyle';
-import SVGLoader from './SVGLoader';
-import createEditor from './testing/createEditor';
-
-describe('Editor.toSVG', () => {
-	it('should correctly nest text objects', async () => {
-		const editor = createEditor();
-		const textStyle: TextRenderingStyle = {
-			fontFamily: 'sans', size: 12, renderingStyle: { fill: Color4.black }
-		};
-		const text = new TextComponent([
-			'Testing...',
-			new TextComponent([ 'Test 2' ], Mat33.translation(Vec2.of(0, 100)), textStyle),
-		], Mat33.identity, textStyle);
-		editor.dispatch(EditorImage.addElement(text));
-
-		const matches = editor.image.getElementsIntersectingRegion(new Rect2(4, -100, 100, 100));
-		expect(matches).toHaveLength(1);
-		expect(text).not.toBeNull();
-
-		const asSVG = editor.toSVG();
-		const allTSpans = [ ...asSVG.querySelectorAll('tspan') ];
-		expect(allTSpans).toHaveLength(1);
-		expect(allTSpans[0].getAttribute('x')).toBe('0');
-		expect(allTSpans[0].getAttribute('y')).toBe('100');
-		expect(allTSpans[0].style.transform).toBe('');
-	});
-
-	it('should preserve empty tspans', async () => {
-		const editor = createEditor();
-		await editor.loadFrom(SVGLoader.fromString(`
-			<svg viewBox="0 0 500 500" width="500" height="500" version="1.1" baseProfile="full" xmlns="http://www.w3.org/2000/svg">
-				<style id="js-draw-style-sheet">
-					path {
-						stroke-linecap:round;
-						stroke-linejoin:round;
-					}
-				</style>
-				<text style="transform: matrix(1, 0, 0, 1, 12, 35); font-family: sans-serif; font-size: 32px; fill: rgb(128, 51, 128);">Testing...<tspan x="3" y="40" style="font-family: sans-serif; font-size: 33px; fill: rgb(128, 51, 128);"></tspan><tspan x="3" y="70">Test 2. ☺</tspan></text>
-			</svg>
-		`, true));
-
-		const textNodesInImage = editor.image.getAllElements().filter(elem => elem instanceof TextComponent);
-		expect(
-			textNodesInImage
-		).toHaveLength(1);
-
-		const asSVG = editor.toSVG();
-		const textObject = asSVG.querySelector('text');
-
-		if (!textObject) {
-			throw new Error('No text object found');
-		}
-
-		const childTextNodes = textObject.querySelectorAll('tspan');
-		expect(childTextNodes).toHaveLength(2);
-	});
-
-	it('should preserve text child size/placement while not saving additional properties', async () => {
-		const secondLineText = 'This is a test of a thing that has been known to break. Will this test catch the issue?';
-		const thirdLineText = 'This is a test of saving/loading multi-line text...';
-
-		const editor = createEditor();
-		await editor.loadFrom(SVGLoader.fromString(`
-			<svg viewBox="0 0 500 500" width="500" height="500" version="1.1" baseProfile="full" xmlns="http://www.w3.org/2000/svg">
-				<style id="js-draw-style-sheet">
-					path {
-						stroke-linecap:round;
-						stroke-linejoin:round;
-					}
-				</style>
-				<text style="transform: matrix(1, 0, 0, 1, 12, 35); font-family: sans-serif; font-size: 32px; fill: rgb(128, 51, 128);">Testing...<tspan x="3" y="40" style="font-family: sans-serif; font-size: 33px; fill: rgb(128, 51, 128);">${secondLineText}</tspan><tspan x="0" y="72" style="font-family: sans-serif; font-size: 32px; fill: rgb(128, 51, 128);">${thirdLineText}</tspan><tspan x="0" y="112" style="font-family: sans-serif; font-size: 32px; fill: rgb(128, 51, 128);">Will it pass or fail?</tspan></text>
-			</svg>
-		`, true));
-
-		expect(
-			editor.image.getAllElements().filter(elem => elem instanceof TextComponent)
-		).toHaveLength(1);
-
-		const asSVG = editor.toSVG();
-		const textObject = asSVG.querySelector('text');
-
-		if (!textObject) {
-			throw new Error('No text object found');
-		}
-
-		expect(textObject.style.transform.replace(/\s+/g, '')).toBe('matrix(1,0,0,1,12,35)');
-		expect(textObject.style.fontFamily).toBe('sans-serif');
-		expect(textObject.style.fontSize).toBe('32px');
-
-		const childTextNodes = textObject.querySelectorAll('tspan');
-		expect(childTextNodes).toHaveLength(3);
-		const firstChild = childTextNodes[0];
-
-		expect(firstChild.textContent).toBe(secondLineText);
-		expect(firstChild.style.transform).toBe('');
-		expect(firstChild.style.fontSize).toBe('33px');
-		expect(firstChild.getAttribute('x')).toBe('3');
-		expect(firstChild.getAttribute('y')).toBe('40');
-
-		// Should not save a fontSize when not necessary (same fill as parent text node)
-		const secondChild = childTextNodes[1];
-		expect(secondChild.style.fontSize ?? '').toBe('');
-
-		// Should not save additional "style" attributes when not necessary
-		// TODO: Uncomment before some future major version release. Currently a "fill" is set for every
-		//  tspan to work around a loading bug.
-		//expect(secondChild.outerHTML).toBe(`<tspan x="0" y="72">${thirdLineText}</tspan>`);
-	});
-});