@yuzhouu/canvas-kit 0.1.12 → 0.1.13

package/contracts/canvasProductControllerContracts.d.ts

@@ -0,0 +1,32 @@
+import type { ReparentShapePlacementFailureReason, ShapeId } from "../_vendor/canvas-core/index";
+export interface CanvasProductShapeUpdate {
+    id: ShapeId;
+    x?: number;
+    y?: number;
+    rotation?: number;
+    scaleX?: number;
+    scaleY?: number;
+    opacity?: number;
+    isHidden?: boolean;
+    isLocked?: boolean;
+    parentId?: string;
+    index?: string;
+    props?: Record<string, unknown>;
+    meta?: Record<string, unknown>;
+}
+export interface CanvasProductLayerPlacement {
+    parentId: string;
+    beforeId?: ShapeId;
+}
+export type CanvasProductLayerPlacementFailureReason = ReparentShapePlacementFailureReason;
+export type CanvasProductLayerPlacementResult = {
+    ok: true;
+    movedIds: ShapeId[];
+} | {
+    ok: false;
+    reason: CanvasProductLayerPlacementFailureReason;
+};
+export interface CanvasProductCreatePageInput {
+    name?: string;
+    meta?: Record<string, unknown>;
+}

package/{core/product-controller → controller}/canvasProductController.d.ts

@@ -1,6 +1,7 @@
-import type { AssetId, Camera, ChangeSource, Editor, LayerOrderDirection, LayerOrderEdge, ReparentShapePlacementFailureReason, ShapeId } from "../../_vendor/canvas-core/index";
-import { type ProductApiRegistry } from "../../_vendor/canvas-product-contracts/index";
-import type { ProductServiceRegistry } from "../runtime/productServices";
+import type { AssetId, Camera, ChangeSource, Editor, LayerOrderDirection, LayerOrderEdge, ShapeId } from "../_vendor/canvas-core/index";
+import { type ProductApiRegistry } from "../_vendor/canvas-product-contracts/index";
+import { type ExecuteCanvasKitDefinedCommand } from "../commands";
+import type { CanvasProductCreatePageInput, CanvasProductLayerPlacement, CanvasProductLayerPlacementResult, CanvasProductShapeUpdate } from "../contracts/canvasProductControllerContracts";
 export interface CanvasProductShapeData {
     id: ShapeId;
     type: string;
@@ -10,7 +11,6 @@ export interface CanvasProductShapeData {
     x: number;
     y: number;
     rotation: number;
-    skewX: number;
     scaleX: number;
     scaleY: number;
     opacity: number;
@@ -25,22 +25,6 @@ export interface CanvasProductAssetData {
     props: Record<string, unknown>;
     meta: Record<string, unknown>;
 }
-export interface CanvasProductShapeUpdate {
-    id: ShapeId;
-    x?: number;
-    y?: number;
-    rotation?: number;
-    skewX?: number;
-    scaleX?: number;
-    scaleY?: number;
-    opacity?: number;
-    isHidden?: boolean;
-    isLocked?: boolean;
-    parentId?: string;
-    index?: string;
-    props?: Record<string, unknown>;
-    meta?: Record<string, unknown>;
-}
 export interface CanvasProductSessionPageState {
     pageId: string;
     selectedShapeIds: ShapeId[];
@@ -109,6 +93,7 @@ export interface CanvasProductLayerNode {
     parentId: string;
     pageId: string;
     type: string;
+    companionIds: ShapeId[];
     childIds: ShapeId[];
     siblingIndex: number;
     depth: number;
@@ -118,18 +103,6 @@ export interface CanvasProductLayerNode {
     isEffectivelyHidden: boolean;
     isEffectivelyLocked: boolean;
 }
-export interface CanvasProductLayerPlacement {
-    parentId: string;
-    beforeId?: ShapeId;
-}
-export type CanvasProductLayerPlacementFailureReason = ReparentShapePlacementFailureReason;
-export type CanvasProductLayerPlacementResult = {
-    ok: true;
-    movedIds: ShapeId[];
-} | {
-    ok: false;
-    reason: CanvasProductLayerPlacementFailureReason;
-};
 export interface CanvasProductLayerActionState {
     canGroup: boolean;
     canUngroup: boolean;
@@ -142,36 +115,20 @@ export interface CanvasProductPageRef {
     index: string;
     meta: Record<string, unknown>;
 }
-export interface CanvasProductCreatePageInput {
-    name?: string;
-    meta?: Record<string, unknown>;
-}
-export interface CanvasProductController<TToolId extends string = string> {
-    apis: ProductApiRegistry;
-    snapshot(): CanvasProductControllerSnapshot<TToolId>;
-    subscribe(listener: CanvasProductControllerChangeListener<TToolId>, options?: CanvasProductSubscriptionOptions): () => void;
+export interface CanvasProductControllerCommands<TToolId extends string = string> {
     clearHistory(): void;
-    canUndo(): boolean;
-    canRedo(): boolean;
     undo(): boolean;
     redo(): boolean;
-    getDocument(): CanvasProductDocumentRef;
     updateDocumentMeta(patch: Record<string, unknown>): CanvasProductDocumentRef;
     updateSessionMeta(patch: Record<string, unknown>): CanvasProductSessionSnapshot<TToolId>;
     select(ids: ShapeId[]): void;
     selectAll(): void;
     deleteSelection(): void;
     deleteShapes(ids: ShapeId[]): void;
-    getAsset(id: AssetId): CanvasProductAssetData | null;
-    resolveAssetUrl(id: AssetId): string | null;
-    getShape(id: ShapeId): CanvasProductShapeData | null;
-    getShapes(ids?: ShapeId[]): CanvasProductShapeData[];
     updateShapes(updates: CanvasProductShapeUpdate[]): ShapeId[];
     updateShapeMeta(id: ShapeId, patch: Record<string, unknown>): ShapeId | null;
     duplicateSelection(): ShapeId[];
     centerOnShape(id: ShapeId): boolean;
-    getLayerTree(pageId?: string): CanvasProductLayerNode[];
-    getLayerNode(id: ShapeId): CanvasProductLayerNode | null;
     setShapesHidden(ids: ShapeId[], isHidden: boolean): ShapeId[];
     setShapesLocked(ids: ShapeId[], isLocked: boolean): ShapeId[];
     groupShapes(ids: ShapeId[]): ShapeId | null;
@@ -179,24 +136,39 @@ export interface CanvasProductController<TToolId extends string = string> {
     moveShapesInParentOrder(ids: ShapeId[], direction: LayerOrderDirection): boolean;
     moveShapesToParentOrderEdge(ids: ShapeId[], edge: LayerOrderEdge): boolean;
     moveShapesToLayerPlacement(ids: ShapeId[], placement: CanvasProductLayerPlacement): CanvasProductLayerPlacementResult;
-    getLayerActionState(ids: ShapeId[]): CanvasProductLayerActionState;
     setTool(toolId: TToolId): void;
     setCamera(camera: Partial<Camera>, pageId?: string): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    resetZoom(): void;
     resetView(): void;
-    getPages(): CanvasProductPageRef[];
     createPage(input?: CanvasProductCreatePageInput): CanvasProductPageRef;
     renamePage(pageId: string, name: string): void;
     updatePageMeta(pageId: string, patch: Record<string, unknown>): string | null;
     deletePage(pageId: string): boolean;
     selectPage(pageId: string): void;
 }
-export interface CanvasProductControllerContext {
+export interface CanvasProductController<TToolId extends string = string> extends CanvasProductControllerCommands<TToolId> {
+    apis: ProductApiRegistry;
+    snapshot(): CanvasProductControllerSnapshot<TToolId>;
+    subscribe(listener: CanvasProductControllerChangeListener<TToolId>, options?: CanvasProductSubscriptionOptions): () => void;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    getDocument(): CanvasProductDocumentRef;
+    getAsset(id: AssetId): CanvasProductAssetData | null;
+    resolveAssetUrl(id: AssetId): string | null;
+    getShape(id: ShapeId): CanvasProductShapeData | null;
+    getShapes(ids?: ShapeId[]): CanvasProductShapeData[];
+    getLayerTree(pageId?: string): CanvasProductLayerNode[];
+    getLayerNode(id: ShapeId): CanvasProductLayerNode | null;
+    getLayerActionState(ids: ShapeId[]): CanvasProductLayerActionState;
+    getPages(): CanvasProductPageRef[];
+}
+export interface CanvasProductControllerOptions<TToolId extends string = string> {
     editor: Editor;
-    services: ProductServiceRegistry;
     apis: ProductApiRegistry;
     productId: string;
-}
-export interface CanvasProductControllerOptions<TToolId extends string = string> extends CanvasProductControllerContext {
     assertToolId: (toolId: string) => asserts toolId is TToolId;
+    executeCommand: ExecuteCanvasKitDefinedCommand;
 }
 export declare function createCanvasProductController<TToolId extends string = string>(options: CanvasProductControllerOptions<TToolId>): CanvasProductController<TToolId>;

package/controller/index.d.ts

@@ -0,0 +1,3 @@
+export { createCanvasProductController } from "./canvasProductController";
+export type { CanvasProductAssetData, CanvasProductController, CanvasProductControllerCommands, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductCommittedChange, CanvasProductControllerSnapshot, CanvasProductControllerOptions, CanvasProductDocumentRef, CanvasProductLayerActionState, CanvasProductLayerNode, CanvasProductPageRef, CanvasProductShapeData, CanvasProductSessionPageState, CanvasProductSessionSnapshot, CanvasProductRealtimeChange, CanvasProductSubscriptionOptions, } from "./canvasProductController";
+export type { CanvasProductCreatePageInput, CanvasProductLayerPlacement, CanvasProductLayerPlacementFailureReason, CanvasProductLayerPlacementResult, CanvasProductShapeUpdate, } from "../contracts/canvasProductControllerContracts";

package/{core/product-controller/productLayerTree.d.ts → controller/layerTree.d.ts}

@@ -1,4 +1,4 @@
-import type { Editor, PageId, ShapeId } from "../../_vendor/canvas-core/index";
+import type { Editor, PageId, ShapeId } from "../_vendor/canvas-core/index";
 import type { CanvasProductLayerNode } from "./canvasProductController";
 export declare function getCanvasProductLayerTree({ editor, pageId, }: {
     editor: Editor;

package/index.d.ts

@@ -7,8 +7,8 @@ export { frameApiToken } from "./_vendor/plugin-frame/index";
 export type { FrameApi, FrameInput, FrameShapeProps, } from "./_vendor/plugin-frame/index";
 export { geoApiToken } from "./_vendor/plugin-geo/index";
 export type { GeoApi, GeoRectangleInput, GeoShapeKind, GeoShapeInput, GeoShapeProps, } from "./_vendor/plugin-geo/index";
-export type { ImageAssetProps, ImageShapeProps, } from "./_vendor/plugin-image/index";
-export type { AssetId, CustomShapeColorRef, EditorPlugin, ShapeColor, ThemeColorSlot, ThemeColorResolver, ThemeColorTokenName, ThemeShapeColorRef, } from "./_vendor/canvas-core/index";
+export type { ImageAssetProps, ImageShapeCrop, ImageShapeProps, ImageSmudgeBrush, ImageSmudgeStroke, ImageSmudgeStrokePoint, } from "./_vendor/plugin-image/index";
+export type { AssetId, Camera, ChangeSource, CustomShapeColorRef, EditorPlugin, LayerOrderDirection, LayerOrderEdge, ShapeColor, ThemeColorSlot, ThemeColorResolver, ThemeColorTokenName, ThemeShapeColorRef, } from "./_vendor/canvas-core/index";
 export type { CanvasRenderPlugin } from "./_vendor/canvas-react/host/index";
 export { createCanvasPluginValueToken, } from "./_vendor/canvas-plugin-sdk/index";
 export { canvasActionsExtension, canvasApisExtension, canvasCapabilitiesExtension, canvasChromeExtension, canvasContextMenuExtension, canvasExportsExtension, canvasImportsExtension, canvasServicesExtension, canvasToolbarExtension, chromeChannels, createChromeChannel, createProductServiceToken, createToolbarChannel, createProductApiToken, toolbarChannels, } from "./_vendor/canvas-product-contracts/index";
@@ -17,33 +17,35 @@ export { canvasToolActionsCapability } from "./plugins/runtime/tool-actions";
 export { canvasImportHostCapability } from "./plugins/runtime/import-host";
 export { canvasClipboardRuntimeCapability, canvasClipboardServiceToken, SYSTEM_CLIPBOARD_COPY_ACTION_ID, SYSTEM_CLIPBOARD_CUT_ACTION_ID, SYSTEM_CLIPBOARD_PASTE_ACTION_ID, SYSTEM_CLIPBOARD_PASTE_AT_POINT_ACTION_ID, } from "./_vendor/plugin-runtime-clipboard/index";
 export type { CanvasPluginCapabilityKind, CanvasPluginCapabilityToken, CanvasPluginRequirement, CanvasPluginSetupExtension, CanvasPluginValueToken, } from "./_vendor/canvas-plugin-sdk/index";
-export type { CanvasAction, CanvasActionAvailability, CanvasActionValue, CanvasPluginCapabilityRegistry, CanvasPluginCapabilitySetup, CanvasShapeRef, ChromeChannel, ChromeContribution, CanvasImportContribution, CanvasImportRequest, CanvasImportResult, CanvasExportArtifact, CanvasExportContribution, CanvasExportFormat, CanvasExportPayload, ContextMenuContribution, ProductApiRegistry, ProductApiToken, ToolbarChannel, ToolbarContribution, ToolbarSurface, } from "./_vendor/canvas-product-contracts/index";
+export type { CanvasAction, CanvasActionAvailability, CanvasActionValue, CanvasPluginCapabilityRegistry, CanvasPluginCapabilitySetup, CanvasShapeRef, ChromeChannel, ChromeContribution, CanvasImportContribution, CanvasImportRequest, CanvasImportResult, CanvasExportArtifact, CanvasExportContribution, CanvasExportFormat, CanvasExportPayload, ContextMenuContribution, ProductApiRegistry, ProductApiToken, ProductServiceFactory, ProductServiceRegistry, ProductServiceSetup, ProductServiceToken, ToolbarChannel, ToolbarContribution, ToolbarSurface, } from "./_vendor/canvas-product-contracts/index";
 export type { ToolbarGroupSource } from "./chrome/toolbar/mergeToolbarGroups";
 export { CanvasKitFloatingToolbarLayer, } from "./chrome/toolbar/CanvasKitFloatingToolbarLayer";
 export { FloatingSelectionToolbarPageSpace, } from "./chrome/toolbar/FloatingSelectionToolbarPageSpace";
 export { useCanvasKitWheelCapture, } from "./chrome/toolbar/CanvasKitWheelCapture";
-export { createTextHostPlugin } from "./features/text/textHostPlugin";
-export { createTextLinkHoverPopoverPresenter, } from "./features/text/link/TextLinkHoverPopover";
-export type { TextLinkHoverPopoverIcons, } from "./features/text/link/TextLinkHoverPopover";
+export { createTextHostPlugin } from "./plugins/host/text/textHostPlugin";
+export { createTextLinkHoverPopoverPresenter, } from "./plugins/host/text/link/TextLinkHoverPopover";
+export type { TextLinkHoverPopoverIcons, } from "./plugins/host/text/link/TextLinkHoverPopover";
 export { useCanvasKitLayerTree, } from "./chrome/useCanvasKitLayerTree";
 import "./index.css";
-export { createCanvasKitController, createCanvasKitControllerWithTools, } from "./controller/canvasKitController";
 export { CanvasKitRoot } from "./react/CanvasKitRoot";
 export { useCanvasKitRuntime } from "./react/useCanvasKitRuntime";
 export { createCanvasKitRuntime } from "./runtime/canvasKitRuntime";
 export { createStandardCanvasKitPlugins, } from "./plugins/standard/createStandardCanvasKitPlugins";
 export { canvasKitApisExtension, canvasKitAssetsExtension, canvasKitLifecycleExtension, canvasKitPersistenceExtension, canvasKitUiExtension, defineCanvasPlugin, } from "./runtime/canvasKitPluginContracts";
-export { CANVAS_KIT_TOOL_IDS } from "./controller/canvasKitController";
-export type { CanvasKitController, CanvasKitControllerRuntimeContext, CanvasKitControllerOptions, CanvasKitControllerSnapshot, CanvasKitControllerWithToolsOptions, CanvasKitBaseController, CanvasKitControllerWithTools, CanvasKitToolId, } from "./controller/canvasKitController";
-export type { CanvasProductAssetData, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductCommittedChange, CanvasProductCreatePageInput, CanvasProductDocumentRef, CanvasProductLayerNode, CanvasProductShapeData, CanvasProductShapeUpdate, CanvasProductRealtimeChange, CanvasProductSubscriptionOptions, } from "./core";
-export type { CanvasKitChromeContext, CanvasKitContextMenuState, CanvasKitGridControls, CanvasKitLayerNode, CanvasKitLayerTreeSource, CanvasKitToolbarActionState, CanvasKitToolbarRuntime, ChromeCommandItem, ChromeItem, ChromeSection, ChromeSurfaces, CanvasActionContext, ContextMenuCommandItem, ContextMenuItem, ContextMenuSection, EditorSelectionMetadata, EditorSelectionState, HistoryControls, PageControls, ShapeId, ToolbarGroup, ToolbarItem, ToolbarSurfaces, ZoomControlsState, } from "./chrome/types";
+export { CANVAS_KIT_TOOL_IDS } from "./canvasKitTools";
+export type { CanvasKitToolId } from "./canvasKitTools";
+export { CANVAS_KIT_COMMAND_TOKENS } from "./commands/commandTokens";
+export type { CanvasKitCommandToken } from "./commands/command";
+export type { CanvasProductAssetData, CanvasProductController, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductControllerSnapshot, CanvasProductCommittedChange, CanvasProductCreatePageInput, CanvasProductDocumentRef, CanvasProductLayerActionState, CanvasProductLayerNode, CanvasProductLayerPlacement, CanvasProductLayerPlacementFailureReason, CanvasProductLayerPlacementResult, CanvasProductPageRef, CanvasProductSessionPageState, CanvasProductSessionSnapshot, CanvasProductShapeData, CanvasProductShapeUpdate, CanvasProductRealtimeChange, CanvasProductSubscriptionOptions, } from "./controller";
+export type { CanvasKitChromeContext, CanvasKitContextMenuState, CanvasKitGridControls, CanvasKitLayerTreeSource, CanvasKitToolbarActionState, CanvasKitToolbarRuntime, ChromeCommandItem, ChromeItem, ChromeSection, ChromeSurfaces, CanvasActionContext, ContextMenuCommandItem, ContextMenuItem, ContextMenuSection, EditorSelectionMetadata, EditorSelectionState, HistoryControls, PageControls, ShapeId, ToolbarGroup, ToolbarItem, ToolbarSurfaces, ZoomControlsState, } from "./chrome/types";
 export type { CanvasKitChromeRenderer, CanvasKitDocumentSeed, CanvasKitRuntime, CanvasKitRuntimeOptions, CanvasKitRuntimeState, CanvasKitStartupResult, } from "./runtime/canvasKitRuntimeContracts";
 export type { CanvasKitRootProps } from "./react/CanvasKitRoot";
 export type { CanvasKitStandardPluginOptions, } from "./plugins/standard/createStandardCanvasKitPlugins";
-export type { CanvasKitPluginAssetSetup, CanvasKitPluginLifecycleSetup, CanvasKitPluginPersistence, CanvasKitPluginSetup, CanvasKitPluginSetupContext, CanvasKitPluginUiSetup, CanvasPluginApi, CanvasPluginBeforeReadyContext, CanvasPluginBeforeReady, CanvasPluginBeforeCommand, CanvasPluginBeforeCommandContext, CanvasPluginLifecycleSetup, CanvasPluginComponent, CanvasPluginComponentProps, CanvasPlugin, CanvasPluginDefinition, CanvasPluginInput, CanvasPluginContext, CanvasPluginProvider, } from "./runtime/canvasKitPluginContracts";
-export type { ProductPersistenceAdapter, ProductPersistenceLoadResult, ProductAssetResolverService, ProductServiceFactory, ProductServiceRegistry, ProductServiceSetup, ProductServiceToken, } from "./core";
+export type { CanvasKitPluginAssetSetup, CanvasPluginApi, CanvasPluginBeforeReadyContext, CanvasPluginBeforeReady, CanvasPluginBeforeCommand, CanvasPluginBeforeCommandContext, CanvasPluginLifecycleSetup, CanvasPluginPersistence, CanvasPluginComponent, CanvasPluginComponentProps, CanvasPlugin, CanvasPluginDefinition, CanvasPluginInput, CanvasPluginContext, CanvasPluginProvider, CanvasPluginSetup, CanvasPluginSetupContext, CanvasPluginUiSetup, } from "./runtime/canvasKitPluginContracts";
+export type { ProductPersistenceAdapter, ProductPersistenceLoadResult, } from "./runtime/persistenceContracts";
+export type { ProductAssetResolverService, } from "./runtime/productAssetResolvers";
 export type { CanvasClipboardService, } from "./_vendor/plugin-runtime-clipboard/index";
 export { canvasExportApiToken } from "./_vendor/plugin-runtime-export/index";
 export type { CanvasExportAppearance, CanvasExportApi, CanvasExportTarget, CanvasGenericExportInput, CanvasPngExportInput, CanvasSvgExportInput, ExportStatus, PngExportResult, SvgAssetInliner, SvgExportResult, } from "./_vendor/plugin-runtime-export/index";
-export { imageProductControllerToken } from "./features/image";
-export type { ImageInsertInput, ImageInsertSource, ImageInsertStrategy, ImageProductController, ImageShapeCrop, ImageSmudgeBrush, ImageSmudgeConfirmPayload, ImageSmudgeController, ImageSmudgeStroke, ImageSmudgeStrokePoint, } from "./features/image";
+export { canvasKitImageHostApiToken, } from "./plugins/host/image";
+export type { CanvasKitImageHostApi, CanvasKitImageInsertInput, CanvasKitImageInsertSize, CanvasKitImageInsertSource, CanvasKitImageInsertStrategy, CanvasKitImageReplaceInput, CanvasKitImageSmudgeConfirmPayload, CanvasKitImageSmudgeController, } from "./plugins/host/image";