@plait/core 0.2.4 → 0.3.0

package/interfaces/board.d.ts

@@ -10,14 +10,15 @@ import { RoughSVG } from 'roughjs/bin/svg';
 import { BoardComponentInterface } from '../board/board.component.interface';
 import { Point } from './point';
 import { RectangleClient } from './rectangle-client';
-import { Path } from './path';
+import { PathRef, PathRefOptions } from './path-ref';
 import { PlaitNode } from './node';
+import { Path } from './path';
 export interface PlaitBoard {
     viewport: Viewport;
     children: PlaitElement[];
     operations: PlaitOperation[];
     selection: Selection | null;
-    pointer: PlaitPointerType;
+    pointer: PlaitPointerType | string;
     history: PlaitHistory;
     options: PlaitBoardOptions;
     undo: () => void;
@@ -43,6 +44,8 @@ export interface PlaitBoard {
     isMovable: (element: PlaitElement) => boolean;
     getRectangle: (element: PlaitElement) => RectangleClient | null;
     isWithinSelection: (element: PlaitElement) => boolean;
+    pathRef: (path: Path, options?: PathRefOptions) => PathRef;
+    pathRefs: () => Set<PathRef>;
 }
 export interface PlaitBoardChangeEvent {
     children: PlaitElement[];
@@ -71,4 +74,7 @@ export declare const PlaitBoard: {
     isFocus(board: PlaitBoard): boolean;
     isReadonly(board: PlaitBoard): boolean;
     hasBeenTextEditing(board: PlaitBoard): boolean;
+    getPointer<T = PlaitPointerType>(board: PlaitBoard): T;
+    isPointer<T_1 = PlaitPointerType>(board: PlaitBoard, pointer: T_1): boolean;
+    getMovingPoint(board: PlaitBoard): Point | undefined;
 };

package/interfaces/node.d.ts

@@ -15,6 +15,6 @@ export declare const PlaitNode: {
      * the tree, but you can pass the `reverse: true` option to go bottom-up.
      */
     parents(root: PlaitBoard, path: Path, options?: NodeParentsOptions): Generator<PlaitNode, void, undefined>;
-    get(root: PlaitBoard, path: Path): PlaitNode;
+    get<T extends PlaitElement = PlaitElement>(root: PlaitBoard, path: Path): T;
     last(board: PlaitBoard, path: Path): PlaitElement;
 };

package/interfaces/path-ref.d.ts

@@ -0,0 +1,13 @@
+import { PlaitOperation } from './operation';
+import { Path } from './path';
+export interface PathRef {
+    current: Path | null;
+    affinity: 'forward' | 'backward' | null;
+    unref(): Path | null;
+}
+export interface PathRefOptions {
+    affinity?: 'forward' | 'backward' | null;
+}
+export declare const PathRef: {
+    transform(ref: PathRef, op: PlaitOperation): void;
+};

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@plait/core",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "peerDependencies": {
-    "@angular/common": "^12.2.0",
-    "@angular/core": "^12.2.0"
+    "@angular/common": "^15.2.2",
+    "@angular/core": "^15.2.2"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/plugins/create-board.d.ts

@@ -1,3 +1,3 @@
 import { PlaitBoard, PlaitBoardOptions } from '../interfaces/board';
 import { PlaitElement } from '../interfaces/element';
-export declare function createBoard(children: PlaitElement[], options: PlaitBoardOptions): PlaitBoard;
+export declare function createBoard(children: PlaitElement[], options?: PlaitBoardOptions): PlaitBoard;

package/public-api.d.ts

@@ -11,3 +11,4 @@ export * from './transforms';
 export * from './utils';
 export * from './plugins/with-selection';
 export * from './plugins/with-moving';
+export * from './testing';

package/testing/core/create-board.d.ts

@@ -0,0 +1,6 @@
+import { PlaitBoardOptions, PlaitElement, PlaitPlugin } from '../../interfaces';
+/**
+ * 1.create board instance
+ * 2.build fake node weak map
+ */
+export declare const createTestingBoard: (plugins: PlaitPlugin[], children: PlaitElement[], options?: PlaitBoardOptions) => import("../../interfaces").PlaitBoard;

package/testing/core/fake-weak-map.d.ts

@@ -0,0 +1,4 @@
+import { PlaitBoard } from "../../interfaces/board";
+import { PlaitNode } from "../../interfaces/node";
+export declare const fakeNodeWeakMap: (object: PlaitNode | PlaitBoard) => void;
+export declare const clearNodeWeakMap: (object: PlaitNode | PlaitBoard) => void;

package/testing/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './create-board';
+export * from './fake-weak-map';

package/testing/index.d.ts

@@ -0,0 +1 @@
+export * from './core';

package/transforms/board.d.ts

@@ -1,6 +1,6 @@
 import { PlaitBoard } from '../interfaces/board';
 import { PlaitPointerType } from '../interfaces/pointer';
-export declare const updatePointerType: (board: PlaitBoard, pointer: PlaitPointerType) => void;
+export declare const updatePointerType: <T extends string = PlaitPointerType>(board: PlaitBoard, pointer: T) => void;
 export declare const BoardTransforms: {
-    updatePointerType: (board: PlaitBoard, pointer: PlaitPointerType) => void;
+    updatePointerType: <T extends string = PlaitPointerType>(board: PlaitBoard, pointer: T) => void;
 };

package/utils/selected-element.d.ts

@@ -1,7 +1,7 @@
 import { PlaitBoard } from '../interfaces/board';
-import { Range } from '../interfaces/selection';
+import { Selection, Range } from '../interfaces/selection';
 import { PlaitElement } from '../interfaces/element';
-export declare const getHitElements: (board: PlaitBoard) => PlaitElement[];
+export declare const getHitElements: (board: PlaitBoard, selection?: Selection) => PlaitElement[];
 export declare const isIntersectionElements: (board: PlaitBoard, elements: PlaitElement[], ranges: Range[]) => boolean;
 export declare const cacheSelectedElements: (board: PlaitBoard, selectedElements: PlaitElement[]) => void;
 export declare const getSelectedElements: (board: PlaitBoard) => PlaitElement[];

package/utils/weak-maps.d.ts

@@ -4,6 +4,7 @@ import { PlaitElement } from '../interfaces/element';
 import { PlaitBoard } from '../interfaces/board';
 import { Point } from '../interfaces/point';
 import { Ancestor } from '../interfaces/node';
+import { PathRef } from '../interfaces/path-ref';
 export declare const IS_BOARD_CACHE: WeakMap<Object, boolean>;
 export declare const FLUSHING: WeakMap<PlaitBoard, boolean>;
 export declare const NODE_TO_INDEX: WeakMap<PlaitElement, number>;
@@ -20,3 +21,4 @@ export declare const BOARD_TO_VIEWPORT_ORIGINATION: WeakMap<PlaitBoard, Point>;
 export declare const BOARD_TO_IS_SELECTION_MOVING: WeakMap<PlaitBoard, boolean>;
 export declare const BOARD_TO_TEMPORARY_ELEMENTS: WeakMap<PlaitBoard, PlaitElement[]>;
 export declare const BOARD_TO_MOVING_ELEMENT: WeakMap<PlaitBoard, PlaitElement[]>;
+export declare const PATH_REFS: WeakMap<PlaitBoard, Set<PathRef>>;