js-draw 0.0.1

package/src/types.ts

@@ -0,0 +1,133 @@
+// Types related to the image editor
+
+import EventDispatcher from './EventDispatcher';
+import Mat33 from './geometry/Mat33';
+import { Point2, Vec2 } from './geometry/Vec2';
+import Vec3 from './geometry/Vec3';
+import BaseTool from './tools/BaseTool';
+import AbstractComponent from './components/AbstractComponent';
+import Rect2 from './geometry/Rect2';
+import Pointer from './Pointer';
+
+
+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,
+}
+
+// [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;
+	readonly key: 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 | WheelEvt | GestureCancelEvt | PointerEvt;
+
+export type EditorNotifier = EventDispatcher<EditorEventType, EditorEventDataType>;
+
+export enum EditorEventType {
+	ToolEnabled,
+	ToolDisabled,
+	ToolUpdated,
+	UndoRedoStackUpdated,
+	ObjectAdded,
+	ViewportChanged,
+	DisplayResized,
+}
+
+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;
+}
+
+export interface DisplayResizedEvent {
+	readonly kind: EditorEventType.DisplayResized;
+	readonly newSize: Vec2;
+}
+
+export interface EditorUndoStackUpdated {
+	readonly kind: EditorEventType.UndoRedoStackUpdated;
+	readonly undoStackSize: number;
+	readonly redoStackSize: number;
+}
+
+export type EditorEventDataType = EditorToolEvent | EditorObjectEvent | EditorViewportChangedEvent | DisplayResizedEvent | EditorUndoStackUpdated;
+
+
+// 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;
+
+export type ComponentAddedListener = (component: AbstractComponent)=> void;
+export interface ImageLoader {
+	// Returns the main region of the loaded image
+	start(
+		onAddComponent: ComponentAddedListener, onProgressListener: OnProgressListener
+	): Promise<Rect2>;
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+	"compilerOptions": {
+		"alwaysStrict": true,
+		"target": "ES2015",
+		"forceConsistentCasingInFileNames": true,
+		"listEmittedFiles": false,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noUnusedLocals": true,
+		"strictBindCallApply": true,
+		"strictFunctionTypes": true,
+		"strictNullChecks": true,
+		"esModuleInterop": true,
+		"moduleResolution": "Node",
+		"declaration": true,
+		"outDir": "dist/",
+	},
+	"include": [
+		"**/*.ts",
+	],
+	"exclude": [
+		"**/node_modules",
+
+		// Files that don't need transpilation
+		"**/*.test.ts",
+	],
+}