@yuzhouu/canvas-kit 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,6 +43,7 @@ export interface ShapeUpdate {
43
43
  parentId?: ShapeParentId;
44
44
  index?: string;
45
45
  props?: Record<string, unknown>;
46
+ meta?: Record<string, unknown>;
46
47
  }
47
48
  export interface ReparentShapesInput {
48
49
  ids: ShapeId[];
@@ -129,7 +129,7 @@ export declare abstract class ShapeUtil<S extends ShapeRecordBase = ShapeRecordB
129
129
  isTransformDescendantContainer(_shape: S): boolean;
130
130
  shouldRotateDescendants(shape: S): boolean;
131
131
  canUngroupChildren(_shape: S): boolean;
132
- canStartTranslateFromSelectionBounds(_shape: S): boolean;
132
+ canStartTranslateFromSelectionBounds(_shape: S, _input: ShapeSelectionFrameInput): boolean;
133
133
  canSnap(_shape: S): boolean;
134
134
  getBoundsSnapGeometry(_shape: S): ShapeBoundsSnapGeometry;
135
135
  getHandleSnapGeometry(shape: S): ShapeHandleSnapGeometry;
@@ -1,4 +1,4 @@
1
- import { Box, ShapeUtil, Vec, type ShapeBrushWrapInput, type ShapeGeometryInput, type ShapeSelectionHandleAnchorInput, type ShapeSelectionHandleAnchors, type ShapeLineSegmentHitTestInput, type ShapeSelectionOverlayInfo, type ShapeSelectionOverlayInfoInput, type ShapeSelectionPagePointsInput, type ShapeSelectionPagePoints, type ShapePointHitTestInput, type ShapeUpdate } from "../canvas-core/index";
1
+ import { Box, ShapeUtil, Vec, type ShapeBrushWrapInput, type ShapeGeometryInput, type ShapeSelectionHandleAnchorInput, type ShapeSelectionHandleAnchors, type ShapeSelectionFrameInput, type ShapeLineSegmentHitTestInput, type ShapeSelectionOverlayInfo, type ShapeSelectionOverlayInfoInput, type ShapeSelectionPagePointsInput, type ShapeSelectionPagePoints, type ShapePointHitTestInput, type ShapeUpdate } from "../canvas-core/index";
2
2
  import { type ArrowShapeProps, type ArrowShapeRecord } from "./types";
3
3
  export declare class ArrowShapeUtil extends ShapeUtil<ArrowShapeRecord> {
4
4
  readonly type: "arrow";
@@ -12,8 +12,9 @@ export declare class ArrowShapeUtil extends ShapeUtil<ArrowShapeRecord> {
12
12
  updateSelectionPagePoints(shape: ArrowShapeRecord, input: ShapeSelectionPagePointsInput): ShapeUpdate;
13
13
  isWrappedByBrush(shape: ArrowShapeRecord, input: ShapeBrushWrapInput): boolean;
14
14
  getSelectionPagePoints(shape: ArrowShapeRecord): ShapeSelectionPagePoints;
15
- contributesToSelectionFrame(_shape: ArrowShapeRecord): boolean;
16
- canStartTranslateFromSelectionBounds(_shape: ArrowShapeRecord): boolean;
15
+ contributesToSelectionFrame(_shape: ArrowShapeRecord, input: ShapeSelectionFrameInput): boolean;
16
+ canUseSelectionFrameHandles(_shape: ArrowShapeRecord, input: ShapeSelectionFrameInput): boolean;
17
+ canStartTranslateFromSelectionBounds(_shape: ArrowShapeRecord, input: ShapeSelectionFrameInput): boolean;
17
18
  getSelectionHandleAnchors(shape: ArrowShapeRecord, input: ShapeSelectionHandleAnchorInput): ShapeSelectionHandleAnchors;
18
19
  getSelectionOverlayInfo(shape: ArrowShapeRecord, input: ShapeSelectionOverlayInfoInput): ShapeSelectionOverlayInfo;
19
20
  hitTest(shape: ArrowShapeRecord, point: Vec, input?: ShapePointHitTestInput): boolean;
@@ -7,6 +7,7 @@ export interface CreateArrowInput {
7
7
  endBinding?: TerminalBindingTargetInput | null;
8
8
  props?: Partial<ArrowShapeProps>;
9
9
  parentId?: PageId;
10
+ meta?: Record<string, unknown>;
10
11
  }
11
12
  export declare function createArrow(editor: Editor, input: CreateArrowInput, source?: ChangeSource): ArrowShapeRecord;
12
13
  export declare function applyResolvedTerminalBinding(editor: Editor, shapeId: ShapeId | null, terminal: ArrowTerminal, resolvedBinding: ResolvedTerminalBinding, source?: ChangeSource): ArrowShapeRecord | null;
@@ -0,0 +1,6 @@
1
+ export declare function normalizeImageCornerRadius(value: unknown, fallback?: number): number;
2
+ export declare function getImageCornerRadiusForBounds({ cornerRadius, h, w, }: {
3
+ cornerRadius: unknown;
4
+ h: number;
5
+ w: number;
6
+ }): number;
@@ -8,6 +8,7 @@ export declare const IMAGE_CROP_DONE_TOOLBAR_ACTION_ID = "image.crop.done";
8
8
  export declare const IMAGE_CROP_ZOOM_TOOLBAR_ACTION_ID = "image.crop.zoom";
9
9
  export declare const IMAGE_CROP_ASPECT_RATIO_TOOLBAR_ACTION_ID = "image.crop.aspect-ratio";
10
10
  export declare const IMAGE_CROP_RESET_TOOLBAR_ACTION_ID = "image.crop.reset";
11
+ export declare const IMAGE_CORNER_RADIUS_TOOLBAR_ACTION_ID = "image.corner-radius";
11
12
  export declare class ImageShapeSvgExporter implements ShapeSvgExporter<ImageShapeRecord> {
12
13
  readonly type: "image";
13
14
  toSvg(shape: ImageShapeRecord, context: SvgExportContext): SvgNode | null;
@@ -1,4 +1,4 @@
1
- export { IMAGE_CROP_ASPECT_RATIO_TOOLBAR_ACTION_ID, IMAGE_CROP_DONE_TOOLBAR_ACTION_ID, IMAGE_CROP_RESET_TOOLBAR_ACTION_ID, IMAGE_CROP_TOOLBAR_ACTION_ID, IMAGE_CROP_ZOOM_TOOLBAR_ACTION_ID, IMAGE_DOWNLOAD_TOOLBAR_ACTION_ID, IMAGE_INSERT_TOOLBAR_ACTION_ID, IMAGE_REPLACE_TOOLBAR_ACTION_ID, ImageShapeSvgExporter, createImageEditorPlugin, isImageCropToolbarSession, } from "./editor";
1
+ export { IMAGE_CROP_ASPECT_RATIO_TOOLBAR_ACTION_ID, IMAGE_CROP_DONE_TOOLBAR_ACTION_ID, IMAGE_CROP_RESET_TOOLBAR_ACTION_ID, IMAGE_CROP_TOOLBAR_ACTION_ID, IMAGE_CROP_ZOOM_TOOLBAR_ACTION_ID, IMAGE_CORNER_RADIUS_TOOLBAR_ACTION_ID, IMAGE_DOWNLOAD_TOOLBAR_ACTION_ID, IMAGE_INSERT_TOOLBAR_ACTION_ID, IMAGE_REPLACE_TOOLBAR_ACTION_ID, ImageShapeSvgExporter, createImageEditorPlugin, isImageCropToolbarSession, } from "./editor";
2
2
  export { createImageCanvasPlugin } from "./canvas";
3
3
  export { createImageCropInteractionHandler, createImageCropSelectionHandleInteractionHandler, } from "./cropInteractions";
4
4
  export { getImageCropModeMarkId } from "./crop";
@@ -27,6 +27,7 @@ export interface ImageShapeProps {
27
27
  h: number;
28
28
  assetId: AssetId | null;
29
29
  crop: ImageShapeCrop | null;
30
+ cornerRadius: number;
30
31
  altText: string;
31
32
  }
32
33
  export interface ImageShapeRecord extends ShapeRecordBase<"image", ImageShapeProps> {
@@ -10,6 +10,7 @@ export interface BuiltInCanvasShapeInput {
10
10
  fill?: ShapeColor;
11
11
  stroke?: ShapeColor;
12
12
  strokeWidth?: number;
13
+ meta?: Record<string, unknown>;
13
14
  }
14
15
  export interface BuiltInCanvasTextInput {
15
16
  x: number;
@@ -21,6 +22,7 @@ export interface BuiltInCanvasTextInput {
21
22
  color?: ShapeColor;
22
23
  size?: TextShapeProps["size"];
23
24
  textAlign?: TextShapeProps["textAlign"];
25
+ meta?: Record<string, unknown>;
24
26
  }
25
27
  export interface BuiltInCanvasFrameInput extends BuiltInCanvasShapeInput {
26
28
  name?: string;
@@ -48,6 +50,7 @@ export interface BuiltInCanvasArrowInput {
48
50
  headEnd?: ArrowShapeProps["headEnd"];
49
51
  startBinding?: BuiltInCanvasArrowBindingInput | null;
50
52
  endBinding?: BuiltInCanvasArrowBindingInput | null;
53
+ meta?: Record<string, unknown>;
51
54
  }
52
55
  export interface BuiltInGeoController {
53
56
  createRectangle(input: BuiltInCanvasShapeInput): CanvasProductShapeRef | null;
@@ -5,6 +5,38 @@ export interface CanvasProductShapeRef {
5
5
  id: ShapeId;
6
6
  type: string;
7
7
  }
8
+ export interface CanvasProductShapeData {
9
+ id: ShapeId;
10
+ type: string;
11
+ parentId: string;
12
+ pageId: string | null;
13
+ index: string;
14
+ x: number;
15
+ y: number;
16
+ rotation: number;
17
+ scaleX: number;
18
+ scaleY: number;
19
+ opacity: number;
20
+ isHidden: boolean;
21
+ isLocked: boolean;
22
+ props: Record<string, unknown>;
23
+ meta: Record<string, unknown>;
24
+ }
25
+ export interface CanvasProductShapeUpdate {
26
+ id: ShapeId;
27
+ x?: number;
28
+ y?: number;
29
+ rotation?: number;
30
+ scaleX?: number;
31
+ scaleY?: number;
32
+ opacity?: number;
33
+ isHidden?: boolean;
34
+ isLocked?: boolean;
35
+ parentId?: string;
36
+ index?: string;
37
+ props?: Record<string, unknown>;
38
+ meta?: Record<string, unknown>;
39
+ }
8
40
  export interface CanvasProductSessionPageState {
9
41
  pageId: string;
10
42
  selectedShapeIds: ShapeId[];
@@ -87,6 +119,10 @@ export interface CanvasProductController<TToolId extends string = string> {
87
119
  selectAll(): void;
88
120
  deleteSelection(): void;
89
121
  deleteShapes(ids: ShapeId[]): void;
122
+ getShape(id: ShapeId): CanvasProductShapeData | null;
123
+ getShapes(ids?: ShapeId[]): CanvasProductShapeData[];
124
+ updateShapes(updates: CanvasProductShapeUpdate[]): ShapeId[];
125
+ updateShapeMeta(id: ShapeId, patch: Record<string, unknown>): ShapeId | null;
90
126
  duplicateSelection(): ShapeId[];
91
127
  centerOnShape(id: ShapeId): boolean;
92
128
  getLayerTree(pageId?: string): CanvasProductLayerNode[];
@@ -1,4 +1,4 @@
1
1
  export { createProductFeatureControllerRegistry, createProductFeatureControllerToken, } from "./featureControllerRegistry";
2
2
  export type { ProductFeatureControllerRegistry, ProductFeatureControllerRegistryRuntime, ProductFeatureControllerToken, } from "./featureControllerRegistry";
3
3
  export { createCanvasProductController } from "./canvasProductController";
4
- export type { CanvasProductController, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductControllerContext, CanvasProductControllerOptions, CanvasProductControllerSnapshot, CanvasProductLayerActionState, CanvasProductLayerNode, CanvasProductLayerPlacement, CanvasProductLayerPlacementFailureReason, CanvasProductLayerPlacementResult, CanvasProductPageRef, CanvasProductSessionPageState, CanvasProductSessionSnapshot, CanvasProductShapeRef, } from "./canvasProductController";
4
+ export type { CanvasProductController, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductControllerContext, CanvasProductControllerOptions, CanvasProductControllerSnapshot, CanvasProductLayerActionState, CanvasProductLayerNode, CanvasProductLayerPlacement, CanvasProductLayerPlacementFailureReason, CanvasProductLayerPlacementResult, CanvasProductPageRef, CanvasProductShapeData, CanvasProductSessionPageState, CanvasProductSessionSnapshot, CanvasProductShapeRef, CanvasProductShapeUpdate, } from "./canvasProductController";
package/core/index.d.ts CHANGED
@@ -8,7 +8,7 @@ export type { CanvasProductRuntimeContribution, } from "./runtime/productContrib
8
8
  export type { ProductContextMenuRegistry, ProductPluginHostRuntime, ProductToolbarRegistry, } from "./runtime/productHost";
9
9
  export type { ProductAssetResolverService, ProductServiceFactory, ProductServiceFactoryContext, ProductServiceRegistry, ProductServiceRegistryRuntime, ProductServiceToken, } from "./runtime/productServices";
10
10
  export type { ProductFeatureControllerRegistry, ProductFeatureControllerRegistryRuntime, ProductFeatureControllerToken, } from "./controller/featureControllerRegistry";
11
- export type { CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, } from "./controller";
11
+ export type { CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductShapeData, CanvasProductShapeUpdate, } from "./controller";
12
12
  export { SYSTEM_SELECTION_BRING_FORWARD_ACTION_ID, SYSTEM_SELECTION_BRING_TO_FRONT_ACTION_ID, SYSTEM_SELECTION_DELETE_ACTION_ID, SYSTEM_SELECTION_DUPLICATE_ACTION_ID, SYSTEM_SELECTION_FLIP_HORIZONTAL_ACTION_ID, SYSTEM_SELECTION_FLIP_VERTICAL_ACTION_ID, SYSTEM_SELECTION_GROUP_ACTION_ID, SYSTEM_SELECTION_RESET_ROTATION_ACTION_ID, SYSTEM_SELECTION_SELECT_ALL_ACTION_ID, SYSTEM_SELECTION_SEND_BACKWARD_ACTION_ID, SYSTEM_SELECTION_SEND_TO_BACK_ACTION_ID, SYSTEM_SELECTION_UNGROUP_ACTION_ID, runCanvasAction, } from "./features/actions/canvasActions";
13
13
  export { createToolbarProductContribution } from "./features/toolbar/toolbarContribution";
14
14
  export { createCanvasActionContext } from "./features/actions/canvasActionContext";
package/index.d.ts CHANGED
@@ -11,7 +11,8 @@ export { CanvasKitRoot } from "./react/CanvasKitRoot";
11
11
  export { defineCanvasKit } from "./product/canvasKitProduct";
12
12
  export { CANVAS_KIT_TOOL_IDS } from "./controller/canvasKitController";
13
13
  export type { CanvasKitController, CanvasKitControllerRuntimeContext, CanvasKitControllerOptions, CanvasKitControllerSnapshot, CanvasKitControllerWithToolsOptions, CanvasKitBaseController, CanvasKitControllerWithTools, CanvasKitFrameInput, CanvasKitShapeInput, CanvasKitTextInput, CanvasKitToolId, } from "./controller/canvasKitController";
14
- export type { CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, } from "./core";
14
+ export type { BuiltInCanvasArrowInput as CanvasKitArrowInput } from "./builtins";
15
+ export type { CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductShapeData, CanvasProductShapeUpdate, } from "./core";
15
16
  export type { CanvasKitChromeContext, CanvasKitContextMenuState, CanvasKitGridControls, CanvasKitLayerNode, CanvasKitLayerTreeSource, CanvasKitPersistenceControls, CanvasKitToolbarActionState, CanvasKitToolbarRuntime, ContextMenuCommandItem, ContextMenuItem, ContextMenuSection, EditorSelectionState, HistoryControls, PageControls, ShapeId, SvgExportControls, CanvasActionValue, CanvasActionContext, ToolbarGroup, ToolbarItem, ToolbarSurfaces, ZoomControlsState, } from "./chrome/types";
16
17
  export type { CanvasKitDocumentSeed, CanvasKitExtensionOptions, CanvasKitProduct, CanvasKitProductOptions, CanvasKitChromeRenderer, } from "./product/canvasKitProduct";
17
18
  export type { ExportStatus, ProductPersistenceStatus, } from "./core";