@ue-too/board 0.5.2 → 0.7.0

package/dist/input-interpretation/input-state-machine/touch-input-state-machine.d.ts

@@ -1,64 +0,0 @@
-import { EventReactions, EventGuards, Guard, TemplateState, TemplateStateMachine } from "@ue-too/being";
-import { TouchContext, TouchPoints } from "./touch-input-context";
-export type TouchStates = "IDLE" | "PENDING" | "IN_PROGRESS";
-/**
- * @description The touch event payload.
- *
- * @category Input State Machine
- */
-export type TouchEventPayload = {
-    points: TouchPoints[];
-};
-/**
- * @description The touch event mapping.
- *
- * @category Input State Machine
- */
-export type TouchEventMapping = {
-    touchstart: TouchEventPayload;
-    touchmove: TouchEventPayload;
-    touchend: TouchEventPayload;
-};
-/**
- * @description The idle state of the touch input state machine.
- *
- * @category Input State Machine
- */
-export declare class IdleState extends TemplateState<TouchEventMapping, TouchContext, TouchStates> {
-    private _eventReactions;
-    protected _guards: Guard<TouchContext, "touchPointsCount">;
-    protected _eventGuards: Partial<EventGuards<TouchEventMapping, TouchStates, TouchContext, typeof this._guards>>;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates>;
-    touchstart(context: TouchContext, payload: TouchEventPayload): void;
-    touchend(context: TouchContext, payload: TouchEventPayload): void;
-}
-/**
- * @description The pending state of the touch input state machine.
- *
- * @category Input State Machine
- */
-export declare class PendingState extends TemplateState<TouchEventMapping, TouchContext, TouchStates> {
-    private _eventReactions;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates>;
-    touchstart(context: TouchContext, payload: TouchEventPayload): void;
-    touchend(context: TouchContext, payload: TouchEventPayload): void;
-    touchmove(context: TouchContext, payload: TouchEventPayload): void;
-}
-/**
- * @description The in progress state of the touch input state machine.
- *
- * @category Input State Machine
- */
-export declare class InProgressState extends TemplateState<TouchEventMapping, TouchContext, TouchStates> {
-    private _eventReactions;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates>;
-    touchmove(context: TouchContext, payload: TouchEventPayload): void;
-    touchend(context: TouchContext, payload: TouchEventPayload): void;
-}
-/**
- * @description The touch input state machine.
- *
- * @category Input State Machine
- */
-export type TouchInputStateMachine = TemplateStateMachine<TouchEventMapping, TouchContext, TouchStates>;
-export declare function createTouchInputStateMachine(context: TouchContext): TouchInputStateMachine;

package/dist/input-interpretation/raw-input-parser/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./vanilla-kmt-event-parser";
-export * from "./vanilla-touch-event-parser";

package/dist/input-interpretation/raw-input-parser/vanilla-touch-event-parser.d.ts

@@ -1,55 +0,0 @@
-import { TouchInputStateMachine } from "../../input-interpretation/input-state-machine/touch-input-state-machine";
-/**
- * @description The touch event parser.
- * This is for the interoperability between the vanilla javascript and the pixijs event system.
- *
- * @category Event Parser
- */
-export interface TouchEventParser {
-    disabled: boolean;
-    panDisabled: boolean;
-    zoomDisabled: boolean;
-    rotateDisabled: boolean;
-    enableStrategy(): void;
-    disableStrategy(): void;
-    setUp(): void;
-    tearDown(): void;
-    attach(canvas: HTMLCanvasElement): void;
-}
-/**
- * @description The vanilla touch event parser.
- * This parser converts the raw events to events that can be used by the input state machine.
- *
- * @category Event Parser
- */
-export declare class VanillaTouchEventParser implements TouchEventParser {
-    private _canvas;
-    private _touchInputTracker;
-    private _disabled;
-    private _panDisabled;
-    private _zoomDisabled;
-    private _rotateDisabled;
-    private touchSM;
-    private _abortController;
-    constructor(canvas: HTMLCanvasElement, touchInputStateMachine: TouchInputStateMachine);
-    get touchStateMachine(): TouchInputStateMachine;
-    bindListeners(): void;
-    enableStrategy(): void;
-    disableStrategy(): void;
-    setUp(): void;
-    tearDown(): void;
-    get disabled(): boolean;
-    get alignCoordinateSystem(): boolean;
-    set alignCoordinateSystem(alignCoordinateSystem: boolean);
-    get panDisabled(): boolean;
-    set panDisabled(panDisabled: boolean);
-    get zoomDisabled(): boolean;
-    set zoomDisabled(zoomDisabled: boolean);
-    get rotateDisabled(): boolean;
-    set rotateDisabled(rotateDisabled: boolean);
-    touchstartHandler(e: TouchEvent): void;
-    touchcancelHandler(e: TouchEvent): void;
-    touchendHandler(e: TouchEvent): void;
-    touchmoveHandler(e: TouchEvent): void;
-    attach(canvas: HTMLCanvasElement): void;
-}

package/dist/input-interpretation/raw-input-publisher/index.d.ts

@@ -1 +0,0 @@
-export * from "./raw-input-publisher";

package/dist/input-interpretation/raw-input-publisher/raw-input-publisher.d.ts

@@ -1,130 +0,0 @@
-import type { Point } from "@ue-too/math";
-import { CameraMux } from "../../camera/camera-mux";
-import { ObservableBoardCamera } from "../../camera/interface";
-/**
- * @description The unsubscribe to user raw input.
- *
- * @category Event Parser
- */
-export type UnsubscribeToUserRawInput = () => void;
-/**
- * @description The raw user pan input event payload.
- *
- * @category Event Parser
- */
-export type RawUserPanInputEventPayload = {
-    diff: Point;
-};
-/**
- * @description The raw user pan input event.
- * Use type to discriminate between pan, zoom, and rotate events.
- *
- * @category Event Parser
- */
-export type RawUserPanInputEvent = {
-    type: "pan";
-} & RawUserPanInputEventPayload;
-/**
- * @description The raw user zoom input event payload.
- *
- * @category Event Parser
- */
-export type RawUserZoomInputEventPayload = {
-    deltaZoomAmount: number;
-    anchorPoint: Point;
-};
-/**
- * @description The raw user zoom input event.
- * Use type to discriminate between pan, zoom, and rotate events.
- *
- * @category Event Parser
- */
-export type RawUserZoomInputEvent = {
-    type: "zoom";
-} & RawUserZoomInputEventPayload;
-/**
- * @description The raw user rotate input event payload.
- *
- * @category Event Parser
- */
-export type RawUserRotateInputEventPayload = {
-    deltaRotation: number;
-};
-/**
- * @description The raw user rotate input event.
- * Use type to discriminate between pan, zoom, and rotate events.
- *
- * @category Event Parser
- */
-export type RawUserRotateInputEvent = {
-    type: "rotate";
-} & RawUserRotateInputEventPayload;
-/**
- * @description The raw user input event map.
- *
- * @category Event Parser
- */
-export type RawUserInputEventMap = {
-    "pan": RawUserPanInputEventPayload;
-    "zoom": RawUserZoomInputEventPayload;
-    "rotate": RawUserRotateInputEventPayload;
-    "all": RawUserInputEvent;
-};
-/**
- * @description The raw user input event.
- * Use type to discriminate between pan, zoom, and rotate events.
- *
- * @category Event Parser
- */
-export type RawUserInputEvent = RawUserPanInputEvent | RawUserZoomInputEvent | RawUserRotateInputEvent;
-/**
- * @description The raw user input callback.
- * This is the function type of callbacks for raw user input events.
- *
- * @category Event Parser
- */
-export type RawUserInputCallback<K extends keyof RawUserInputEventMap> = (event: RawUserInputEventMap[K]) => void;
-export interface UserInputPublisher {
-    notifyPan(diff: Point): void;
-    notifyZoom(deltaZoomAmount: number, anchorPoint: Point): void;
-    notifyRotate(deltaRotation: number): void;
-    on<K extends keyof RawUserInputEventMap>(eventName: K, callback: (event: RawUserInputEventMap[K]) => void): UnsubscribeToUserRawInput;
-}
-/**
- * @description The raw user input publisher.
- * Publishs raw user input events to the input flow control, and subscribers.
- *
- * @category Event Parser
- */
-export declare class RawUserInputPublisher implements UserInputPublisher {
-    private pan;
-    private zoom;
-    private rotate;
-    private all;
-    private _cameraMux;
-    constructor(cameraMux: CameraMux);
-    notifyPan(diff: Point): void;
-    notifyZoom(deltaZoomAmount: number, anchorPoint: Point): void;
-    notifyRotate(deltaRotation: number): void;
-    on<K extends keyof RawUserInputEventMap>(eventName: K, callback: (event: RawUserInputEventMap[K]) => void): UnsubscribeToUserRawInput;
-    get cameraMux(): CameraMux;
-    set cameraMux(cameraMux: CameraMux);
-}
-/**
- * @description Creates a default raw user input publisher.
- *
- * @category Event Parser
- */
-export declare function createDefaultRawUserInputPublisher(camera: ObservableBoardCamera): RawUserInputPublisher;
-export declare class RawUserInputPublisherWithWebWorkerRelay implements UserInputPublisher {
-    private pan;
-    private zoom;
-    private rotate;
-    private all;
-    private webWorker;
-    constructor(webWorker: Worker);
-    notifyPan(diff: Point): void;
-    notifyZoom(deltaZoomAmount: number, anchorPoint: Point): void;
-    notifyRotate(deltaRotation: number): void;
-    on<K extends keyof RawUserInputEventMap>(eventName: K, callback: (event: RawUserInputEventMap[K]) => void): UnsubscribeToUserRawInput;
-}

package/dist/package.json

@@ -1,39 +0,0 @@
-{
-  "name": "@ue-too/board",
-  "type": "module",
-  "version": "0.5.2",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "default": "./index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "main": "./index.js",
-  "types": "./index.d.ts",
-  "module": "./index.js",
-  "dependencies": {
-    "@ue-too/math": "^0.5.2",
-    "@ue-too/being": "^0.5.2"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ue-too/ue-too.git"
-  },
-  "author": "niuee",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/ue-too/ue-too/issues"
-  },
-  "homepage": "https://github.com/ue-too/ue-too#readme",
-  "keywords": [
-    "canvas",
-    "infinite-canvas",
-    "pixi.js",
-    "PIXI"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}

package/dist/utils/coorindate-conversion.d.ts

@@ -1,5 +0,0 @@
-import { Point } from "@ue-too/math";
-export declare function pointConversion(point: Point): {
-    x: number;
-    y: number;
-};

package/dist/utils/drawing-utils.d.ts

@@ -1,55 +0,0 @@
-import type { Point } from "@ue-too/math";
-import { Boundaries } from "../camera/utils/position";
-/**
- * @description Draws a crosshair on the canvas.
- * @deprecated
- *
- * @category Board
- */
-export declare function drawCrossHair(context: CanvasRenderingContext2D, pos: Point, cameraZoomLevel: number, alignCoordinateSystem: boolean, size: number, color?: string): void;
-/**
- * @description Draws a bounding box on the canvas.
- * @deprecated
- *
- * @category Board
- */
-export declare function drawBoundingBox(context: CanvasRenderingContext2D, boundaries: Boundaries, alignCoordinateSystem: boolean): void;
-/**
- * @description Draws the axis of the board.
- * @deprecated
- *
- * @category Board
- */
-export declare function drawAxis(context: CanvasRenderingContext2D, boundaries: Boundaries, zoomLevel: number, alignCoordinateSystem: boolean): void;
-/**
- * @description Draws the grid of the board.
- * argument points are in world space
- * @deprecated
- *
- * @category Board
- */
-export declare function drawGrid(context: CanvasRenderingContext2D, topLeftCorner: Point, topRightCorner: Point, bottomLeftCorner: Point, bottomRightCorner: Point, alignCoordinateSystem: boolean, cameraZoomLevel: number): void;
-/**
- * @description Draws a ruler on the canvas.
- * argument points are in world space
- * @deprecated
- *
- * @category Board
- */
-export declare function drawRulerLegacy(context: CanvasRenderingContext2D, topLeftCorner: Point, topRightCorner: Point, bottomLeftCorner: Point, bottomRightCorner: Point, alignCoordinateSystem: boolean, cameraZoomLevel: number): void;
-/**
- * @description Draws the position text on the canvas.
- * argument points are in world space
- * @deprecated
- *
- * @category Board
- */
-export declare function drawPositionText(context: CanvasRenderingContext2D, pos: Point, cameraZoomLevel: number, alignCoordinateSystem: boolean, offset?: number, color?: string): void;
-/**
- * @description Draws a reference circle on the canvas.
- * argument points are in world space
- * @deprecated
- *
- * @category Board
- */
-export declare function drawReferenceCircle(context: CanvasRenderingContext2D, pos: Point, alignCoordinateSystem: boolean): void;

package/dist/utils/drawing.d.ts

@@ -1,30 +0,0 @@
-import { Point } from "@ue-too/math";
-export declare function drawArrow(context: CanvasRenderingContext2D, cameraZoomLevel: number, startPoint: Point, endPoint: Point, width?: number, arrowRatio?: number): void;
-export declare const MAJOR_TICK_LENGTH = 30;
-export declare const MINOR_TICK_LENGTH: number;
-export declare const HALF_TICK_LENGTH: number;
-export declare const TEXT_MAJOR_TICK_OFFSET = 10;
-export declare const TEXT_HALF_TICK_OFFSET = 2.5;
-export declare const TEXT_MAJOR_TICK_FONT_SIZE = 20;
-export declare const TEXT_HALF_TICK_FONT_SIZE = 10;
-/**
- * @description Draws a ruler on the canvas.
- * argument points are in world space
- *
- * @category Utils
- *
- */
-export declare function drawRuler(context: CanvasRenderingContext2D, topLeftCorner: Point, topRightCorner: Point, bottomLeftCorner: Point, alignCoordinateSystem: boolean, cameraZoomLevel: number): void;
-export declare function calculateTickValues(minValue: number, maxValue: number, orderOfMagnitude?: number): {
-    minMajorTickValue: number;
-    maxMajorTickValue: number;
-    majorTickStep: number;
-    minMinTickValue: number;
-    maxMaxTickValue: number;
-    minTickStep: number;
-    minHalfTickValue: number;
-    maxHalfTickValue: number;
-    halfTickStep: number;
-    calibrationMultiplier: number;
-    normalizedOrderOfMagnitude: number;
-};

package/dist/utils/handler-pipeline.d.ts

@@ -1,30 +0,0 @@
-/**
- * @description Type definition for a handler function that takes a generic value and additional arguments
- * The handler must return the same type as its first argument
- * This is a utility type to be used in the handler pipeline. (Probably don't need to use this directly)
- * Using the {@link createHandlerChain} function to create a handler chain would have typescript infer the correct type for the handler chain.
- *
- * @category Utils
- */
-export type Handler<T, Args extends any[]> = (value: T, ...args: Args) => T;
-/**
- * @description Creates a handler chain from an array of handlers.
- *
- * Use it like this:
- * ```typescript
- * const handlerChain = createHandlerChain(handler1, handler2, handler3);
- * ```
- * or like this:
- * ```typescript
- * const handlers = [handler1, handler2, handler3];
- * const handlerChain = createHandlerChain(handlers);
- * ```
- *
- * The function signature of all the handlers must be the same. (if they're not, you need to explicitly specify the type for the handler chain)
- *
- * @param handlers Array of handler functions to be chained
- * @returns A single handler function that executes all handlers in sequence
- *
- * @category Utils
- */
-export declare function createHandlerChain<T, Args extends any[]>(...handlers: Handler<T, Args>[] | [Handler<T, Args>[]]): Handler<T, Args>;

package/dist/utils/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./coorindate-conversion";
-export * from "./ruler";
-export * from "./observable";
-export * from "./handler-pipeline";
-export * from "./canvas-position-dimension";
-export * from "./drawing-utils";
-export * from "./drawing";
-export * from "./zoomlevel-adjustment";

package/dist/utils/observable.d.ts

@@ -1,9 +0,0 @@
-export type Observer<T extends any[]> = (...data: T) => void;
-export interface SubscriptionOptions {
-    signal?: AbortSignal;
-}
-export declare class Observable<T extends any[]> {
-    private observers;
-    subscribe(observer: Observer<T>, options?: SubscriptionOptions): () => void;
-    notify(...data: T): void;
-}

package/dist/utils/ruler.d.ts

@@ -1 +0,0 @@
-export declare function calculateOrderOfMagnitude(value: number): number;

package/jest.config.js

@@ -1,18 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-export default {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
-    rootDir: '.',
-    testMatch: ['<rootDir>/test/**/*.test.ts'],
-    moduleFileExtensions: ['ts', 'js'],
-    extensionsToTreatAsEsm: ['.ts'],
-    transform: {
-      '^.+\\.ts$': ['ts-jest', {
-        useESM: true,
-        tsconfig: 'tsconfig.spec.json'
-      }]
-    },
-    moduleNameMapper: {
-      '^@ue-too/(.*)$': '<rootDir>/../$1/src'
-    }
-}; 

package/project.json

@@ -1,34 +0,0 @@
-{
-  "name": "board",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/board/src",
-  "projectType": "library",
-  "targets": {
-    "build": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "pnpm build",
-        "cwd": "packages/board"
-      }
-    },
-    "move-package": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "node ../../scripts/move-package.mjs",
-        "cwd": "packages/board"
-      }
-    },
-    "test": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "pnpm test",
-        "cwd": "packages/board"
-      }
-    }
-  },
-  "tags": [],
-  "implicitDependencies": [
-    "math",
-    "being"
-  ]
-}

package/rollup.config.js

@@ -1,29 +0,0 @@
-/**
- * @type {import('rollup').RollupOptions}
- */
-import typescript from '@rollup/plugin-typescript';
-// import nodeResolve from '@rollup/plugin-node-resolve';
-import terser from '@rollup/plugin-terser';
-
-export default {
-	input: 'src/index.ts',
-	output: {
-		file: 'dist/index.js',
-		format: 'esm',
-        sourcemap: true
-	},
-    plugins: [
-        // nodeResolve({
-        //     preferBuiltins: false,
-        // }),
-        typescript({
-            tsconfig: 'tsconfig.json',
-            outputToFilesystem: true,
-            declarationMap: false,
-            paths: undefined,
-            allowImportingTsExtensions: false
-        }),
-        terser()
-    ],
-    external: ['@ue-too/math', '@ue-too/being']
-};