js-draw 0.25.0 → 1.0.0

package/src/types.ts

@@ -1,239 +0,0 @@
-// Types related to the image editor
-
-import EventDispatcher from './EventDispatcher';
-import Mat33 from './math/Mat33';
-import { Point2, Vec2 } from './math/Vec2';
-import Vec3 from './math/Vec3';
-import BaseTool from './tools/BaseTool';
-import AbstractComponent from './components/AbstractComponent';
-import Rect2 from './math/shapes/Rect2';
-import Pointer from './Pointer';
-import Color4 from './Color4';
-import Command from './commands/Command';
-import BaseWidget from './toolbar/widgets/BaseWidget';
-
-
-export type HTMLPointerEventName = 'pointerdown'|'pointermove'|'pointerup'|'pointercancel';
-export type HTMLPointerEventFilter = (eventName: HTMLPointerEventName, event: PointerEvent)=>boolean;
-
-export interface PointerEvtListener {
-	onPointerDown(event: PointerEvt): boolean;
-	onPointerMove(event: PointerEvt): void;
-	onPointerUp(event: PointerEvt): void;
-
-	// Called if a pointer that has been captured by this listener (by returning
-	// `true` from `onPointerDown`) is re-captured by another listener.
-	//
-	// When called, this method should cancel any changes being made by the current
-	// gesture.
-	onGestureCancel(): void;
-}
-
-
-export enum InputEvtType {
-	PointerDownEvt,
-	PointerMoveEvt,
-	PointerUpEvt,
-	GestureCancelEvt,
-
-	WheelEvt,
-	KeyPressEvent,
-	KeyUpEvent,
-
-	CopyEvent,
-	PasteEvent,
-}
-
-// [delta.x] is horizontal scroll,
-// [delta.y] is vertical scroll,
-// [delta.z] is zoom scroll (ctrl+scroll or pinch zoom)
-export interface WheelEvt {
-	readonly kind: InputEvtType.WheelEvt;
-	readonly delta: Vec3;
-	readonly screenPos: Point2;
-}
-
-export interface KeyPressEvent {
-	readonly kind: InputEvtType.KeyPressEvent;
-
-	// key, as given by an HTML `KeyboardEvent`
-	readonly key: string;
-
-	// If `ctrlKey` is undefined, that is equivalent to `ctrlKey = false`.
-	readonly ctrlKey: boolean|undefined;
-
-	// If falsey, the `alt` key is not pressed.
-	readonly altKey: boolean|undefined;
-}
-
-export interface KeyUpEvent {
-	readonly kind: InputEvtType.KeyUpEvent;
-	readonly key: string;
-
-	// As in `KeyPressEvent, if `ctrlKey` is undefined, that is equivalent to
-	// `ctrlKey = false`.
-	readonly ctrlKey: boolean|undefined;
-	readonly altKey: boolean|undefined;
-}
-
-export interface CopyEvent {
-	readonly kind: InputEvtType.CopyEvent;
-	setData(mime: string, data: string): void;
-}
-
-export interface PasteEvent {
-	readonly kind: InputEvtType.PasteEvent;
-	readonly data: string;
-	readonly mime: string;
-}
-
-// Event triggered when pointer capture is taken by a different [PointerEvtListener].
-export interface GestureCancelEvt {
-	readonly kind: InputEvtType.GestureCancelEvt;
-}
-
-interface PointerEvtBase {
-	readonly current: Pointer;
-	readonly allPointers: Pointer[];
-}
-
-export interface PointerDownEvt extends PointerEvtBase {
-	readonly kind: InputEvtType.PointerDownEvt;
-}
-
-export interface PointerMoveEvt extends PointerEvtBase {
-	readonly kind: InputEvtType.PointerMoveEvt;
-}
-
-export interface PointerUpEvt extends PointerEvtBase {
-	readonly kind: InputEvtType.PointerUpEvt;
-}
-
-export type PointerEvt = PointerDownEvt | PointerMoveEvt | PointerUpEvt;
-export type InputEvt = KeyPressEvent | KeyUpEvent | WheelEvt | GestureCancelEvt | PointerEvt | CopyEvent | PasteEvent;
-
-export type EditorNotifier = EventDispatcher<EditorEventType, EditorEventDataType>;
-
-export enum EditorEventType {
-	ToolEnabled,
-	ToolDisabled,
-	ToolUpdated,
-
-	UndoRedoStackUpdated,
-	CommandDone,
-	CommandUndone,
-	ObjectAdded,
-
-	ViewportChanged,
-	DisplayResized,
-
-	ColorPickerToggled,
-	ColorPickerColorSelected,
-	ToolbarDropdownShown,
-}
-
-// Types of `EditorUndoStackUpdated` events.
-export enum UndoEventType {
-	CommandDone,
-	CommandUndone,
-	CommandRedone,
-}
-
-type EditorToolEventType = EditorEventType.ToolEnabled
-	| EditorEventType.ToolDisabled
-	| EditorEventType.ToolUpdated;
-
-export interface EditorToolEvent {
-	readonly kind: EditorToolEventType;
-	readonly tool: BaseTool;
-}
-
-export interface EditorObjectEvent {
-	readonly kind: EditorEventType.ObjectAdded;
-	readonly object: AbstractComponent;
-}
-
-export interface EditorViewportChangedEvent {
-	readonly kind: EditorEventType.ViewportChanged;
-
-	// Canvas -> screen transform
-	readonly newTransform: Mat33;
-	readonly oldTransform: Mat33;
-}
-
-export interface DisplayResizedEvent {
-	readonly kind: EditorEventType.DisplayResized;
-	readonly newSize: Vec2;
-}
-
-export interface EditorUndoStackUpdated {
-	readonly kind: EditorEventType.UndoRedoStackUpdated;
-
-	readonly undoStackSize: number;
-	readonly redoStackSize: number;
-
-	readonly command?: Command;
-	readonly stackUpdateType: UndoEventType;
-}
-
-export interface CommandDoneEvent {
-	readonly kind: EditorEventType.CommandDone;
-	readonly command: Command;
-}
-
-export interface CommandUndoneEvent {
-	readonly kind: EditorEventType.CommandUndone;
-	readonly command: Command;
-}
-
-export interface ColorPickerToggled {
-	readonly kind: EditorEventType.ColorPickerToggled;
-	readonly open: boolean;
-}
-
-export interface ColorPickerColorSelected {
-	readonly kind: EditorEventType.ColorPickerColorSelected;
-	readonly color: Color4;
-}
-
-export interface ToolbarDropdownShownEvent {
-	readonly kind: EditorEventType.ToolbarDropdownShown;
-	readonly parentWidget: BaseWidget;
-}
-
-export type EditorEventDataType = EditorToolEvent | EditorObjectEvent
-	| EditorViewportChangedEvent | DisplayResizedEvent
-	| EditorUndoStackUpdated | CommandDoneEvent | CommandUndoneEvent
-	| ColorPickerToggled | ColorPickerColorSelected
-	| ToolbarDropdownShownEvent;
-
-
-// Returns a Promise to indicate that the event source should pause until the Promise resolves.
-// Returns null to continue loading without pause.
-// [totalToProcess] can be an estimate and may change if a better estimate becomes available.
-export type OnProgressListener =
-	(amountProcessed: number, totalToProcess: number)=> Promise<void>|null|void;
-
-export type ComponentAddedListener = (component: AbstractComponent)=> Promise<void>|void;
-
-// Called when a new estimate for the import/export rect has been generated. This can be called multiple times.
-// Only the last call to this listener must be accurate.
-// The import/export rect is also returned by [start].
-export type OnDetermineExportRectListener = (exportRect: Rect2)=> void;
-
-export interface ImageLoader {
-	start(
-		onAddComponent: ComponentAddedListener,
-		onProgressListener: OnProgressListener,
-		onDetermineExportRect?: OnDetermineExportRectListener,
-	): Promise<void>;
-}
-
-export interface StrokeDataPoint {
-	pos: Point2;
-	width: number;
-
-	/** Time in milliseconds (e.g. as returned by `new Date().getTime()`). */
-	time: number;
-	color: Color4;
-}

package/src/util/assertions.ts

@@ -1,55 +0,0 @@
-
-/**
- * Compile-time assertion that a branch of code is unreachable.
- * @internal
- */
-export const assertUnreachable = (key: never): never => {
-	// See https://stackoverflow.com/a/39419171/17055750
-	throw new Error(`Should be unreachable. Key: ${key}.`);
-};
-
-
-/**
- * Throws an exception if the typeof given value is not a number or `value` is NaN.
- *
- * @example
- * ```ts
- * const foo: unknown = 3;
- * assertIsNumber(foo);
- *
- * assertIsNumber('hello, world'); // throws an Error.
- * ```
- *
- *
- */
-export const assertIsNumber = (value: any, allowNaN: boolean = false): value is number => {
-	if (typeof value !== 'number' || (!allowNaN && isNaN(value))) {
-		throw new Error('Given value is not a number');
-		// return false;
-	}
-
-	return true;
-};
-
-/**
- * Throws if any of `values` is not of type number.
- */
-export const assertIsNumberArray = (
-	values: any[], allowNaN: boolean = false
-): values is number[] => {
-	if (typeof values !== 'object') {
-		throw new Error('Asserting isNumberArray: Given entity is not an array');
-	}
-
-	if (!assertIsNumber(values['length'])) {
-		return false;
-	}
-
-	for (const value of values) {
-		if (!assertIsNumber(value, allowNaN)) {
-			return false;
-		}
-	}
-
-	return true;
-};

package/src/util/fileToBase64.ts

@@ -1,18 +0,0 @@
-
-type ProgressListener = (evt: ProgressEvent<FileReader>)=> void;
-const fileToBase64 = (file: File, onprogress?: ProgressListener): Promise<string|null> => {
-	const reader = new FileReader();
-
-	return new Promise((resolve: (result: string|null)=>void, reject) => {
-		reader.onload = () => resolve(reader.result as string|null);
-		reader.onerror = reject;
-		reader.onabort = reject;
-		reader.onprogress = (evt) => {
-			onprogress?.(evt);
-		};
-
-		reader.readAsDataURL(file);
-	});
-};
-
-export default fileToBase64;

package/src/util/untilNextAnimationFrame.ts

@@ -1,9 +0,0 @@
-
-/** @internal */
-const untilNextAnimationFrame = (): Promise<void> => {
-	return new Promise((resolve) => {
-		requestAnimationFrame(() => resolve());
-	});
-};
-
-export default untilNextAnimationFrame;

package/src/util/waitForAll.ts

@@ -1,18 +0,0 @@
-
-/**
- * Resolves when all given promises have resolved. If no promises are given,
- * does not return a Promise.
- */
-const waitForAll = (results: (Promise<void>|void)[]): Promise<void>|void => {
-	// If any are Promises...
-	if (results.some(command => command && command['then'])) {
-		// Wait for all commands to finish.
-		return Promise.all(results)
-		// Ensure we return a Promise<void> and not a Promise<void[]>
-			.then(() => {});
-	}
-
-	return;
-};
-
-export default waitForAll;

package/src/util/waitForTimeout.ts

@@ -1,9 +0,0 @@
-
-// Returns a promise that resolves after `timeout` milliseconds.
-const waitForTimeout = (timeout: number): Promise<void> => {
-	return new Promise(resolve => {
-		setTimeout(() => resolve(), timeout);
-	});
-};
-
-export default waitForTimeout;