@yuzhouu/canvas-kit 0.1.9 → 0.1.11

package/chrome/usePageControls.d.ts

@@ -1,5 +1,5 @@
 import type { Editor, PageId, PageRecord } from "../_vendor/canvas-core/index";
-import type { CanvasKitHostFeature } from "../runtime/canvasKitHostContracts";
+import type { ExecuteCanvasKitCommand } from "../runtime/canvasKitCommandExecutor";
 export interface PageControls {
     pages: readonly PageRecord[];
     currentPage: PageRecord | null;
@@ -10,7 +10,7 @@ export interface PageControls {
     renameCurrentPage(nextName: string): void;
     selectPage(pageId: PageId): void;
 }
-export declare function usePageControls({ editor, hostFeatures, }: {
+export declare function usePageControls({ editor, executeCommand, }: {
     editor: Editor;
-    hostFeatures: readonly CanvasKitHostFeature[];
+    executeCommand: ExecuteCanvasKitCommand;
 }): PageControls;

package/controller/canvasKitController.d.ts

@@ -1,27 +1,16 @@
-import { type CanvasProductController, type CanvasProductControllerContext, type CanvasProductSessionSnapshot } from "../core/product-controller";
-import type { CanvasRenderPluginHostRuntime } from "../_vendor/canvas-react/host/index";
-import { type BuiltInCanvasController, type BuiltInCanvasControllerSnapshot, type BuiltInCanvasFrameInput, type BuiltInCanvasRectangleInput, type BuiltInCanvasShapeInput, type BuiltInCanvasTextInput } from "../builtins";
-import type { CanvasKitControllerSlot } from "../runtime/canvasKitHostContracts";
-export type CanvasKitShapeInput = BuiltInCanvasShapeInput;
-export type CanvasKitRectangleInput = BuiltInCanvasRectangleInput;
-export type CanvasKitTextInput = BuiltInCanvasTextInput;
-export type CanvasKitFrameInput = BuiltInCanvasFrameInput;
+import { type CanvasProductController, type CanvasProductControllerSnapshot, type CanvasProductControllerContext, type CanvasProductSessionSnapshot } from "../core/product-controller";
 export interface CanvasKitBaseController<TToolId extends string = string> extends CanvasProductController<TToolId> {
 }
-export interface CanvasKitControllerSlots {
-}
-export declare const CANVAS_KIT_TOOL_IDS: readonly ["select", "hand", "rectangle", "ellipse", "diamond", "triangle", "hexagon", "star", "arrow", "draw", "path", "text", "frame", "eraser", "laser"];
+export declare const CANVAS_KIT_TOOL_IDS: readonly ["select", "hand", "rectangle", "ellipse", "rhombus", "triangle", "hexagon", "star", "arrow", "draw", "path", "text", "frame", "eraser", "laser"];
 export type CanvasKitToolId = (typeof CANVAS_KIT_TOOL_IDS)[number];
-export interface CanvasKitControllerSnapshot<TToolId extends string = CanvasKitToolId> extends BuiltInCanvasControllerSnapshot<TToolId> {
+export interface CanvasKitControllerSnapshot<TToolId extends string = CanvasKitToolId> extends CanvasProductControllerSnapshot<TToolId> {
     productId: string;
     session: CanvasProductSessionSnapshot<TToolId>;
 }
-export interface CanvasKitController<TToolId extends string = CanvasKitToolId> extends BuiltInCanvasController<TToolId>, CanvasKitControllerSlots {
+export interface CanvasKitController<TToolId extends string = CanvasKitToolId> extends CanvasKitBaseController<TToolId> {
     snapshot(): CanvasKitControllerSnapshot<TToolId>;
 }
-export interface CanvasKitControllerRuntimeContext extends Omit<CanvasProductControllerContext, "pluginHostRuntime"> {
-    controllerSlots: readonly CanvasKitControllerSlot<string, unknown>[];
-    pluginHostRuntime: CanvasRenderPluginHostRuntime;
+export interface CanvasKitControllerRuntimeContext extends CanvasProductControllerContext {
 }
 export interface CanvasKitControllerOptions<TToolId extends string = CanvasKitToolId> extends CanvasKitControllerRuntimeContext {
     assertToolId?: (toolId: string) => asserts toolId is TToolId;

package/core/index.d.ts

@@ -1,9 +1,7 @@
 export { createDefaultCanvasProductEditor } from "./runtime/productEditor";
+export { createCanvasProductController } from "./product-controller";
 export { cleanupProductAssetsAfterRestore, preloadProductAssets, resolveProductAssetUrl, } from "./runtime/productAssets";
-export { createProductApiRegistry, createProductApiToken, } from "./api/apiRegistry";
 export { createProductServiceRegistry, createProductServiceToken, requireProductService, } from "./runtime/productServices";
-export type { CanvasProductRuntimeInitializer, CanvasProductRuntimeInitializerContext, CreateCanvasProductEditorOptions, ProductPersistenceAdapter, ProductPersistenceRestoreResult, ProductPersistenceStatus, } from "./runtime/productDefinition";
-export type { ProductActionRegistry, ProductContextMenuRegistry, ProductPluginHostRuntime, ProductToolbarRegistry, } from "./runtime/productHost";
-export type { ProductAssetResolverService, ProductServiceFactory, ProductServiceFactoryContext, ProductServiceRegistry, ProductServiceRegistryRuntime, ProductServiceToken, } from "./runtime/productServices";
-export type { ProductApiRegistry, ProductApiRegistryRuntime, ProductApiToken, } from "./api/apiRegistry";
-export type { CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductCreatePageInput, CanvasProductDocumentRef, CanvasProductShapeData, CanvasProductShapeUpdate, } from "./product-controller";
+export type { CreateCanvasProductEditorOptions, ProductPersistenceAdapter, ProductPersistenceLoadResult, } from "./runtime/runtimeContracts";
+export type { ProductAssetResolverService, ProductServiceFactory, ProductServiceFactoryContext, ProductServiceRegistry, ProductServiceRegistryRuntime, ProductServiceSetup, ProductServiceToken, } from "./runtime/productServices";
+export type { CanvasProductAssetData, CanvasProductController, CanvasProductControllerChange, CanvasProductControllerChangeKey, CanvasProductControllerChangeListener, CanvasProductCommittedChange, CanvasProductCreatePageInput, CanvasProductDocumentRef, CanvasProductLayerNode, CanvasProductShapeData, CanvasProductShapeUpdate, CanvasProductRealtimeChange, CanvasProductSubscriptionOptions, } from "./product-controller";

package/core/product-controller/canvasProductController.d.ts

@@ -1,10 +1,6 @@
-import type { Camera, ChangeSource, Editor, LayerOrderDirection, LayerOrderEdge, ReparentShapePlacementFailureReason, ShapeId } from "../../_vendor/canvas-core/index";
+import type { AssetId, Camera, ChangeSource, Editor, LayerOrderDirection, LayerOrderEdge, ReparentShapePlacementFailureReason, ShapeId } from "../../_vendor/canvas-core/index";
+import type { ProductApiRegistry } from "../../_vendor/canvas-plugin-sdk/index";
 import type { ProductServiceRegistry } from "../runtime/productServices";
-import type { ProductApiRegistry } from "../api/apiRegistry";
-export interface CanvasProductShapeRef {
-    id: ShapeId;
-    type: string;
-}
 export interface CanvasProductShapeData {
     id: ShapeId;
     type: string;
@@ -14,6 +10,7 @@ export interface CanvasProductShapeData {
     x: number;
     y: number;
     rotation: number;
+    skewX: number;
     scaleX: number;
     scaleY: number;
     opacity: number;
@@ -22,11 +19,18 @@ export interface CanvasProductShapeData {
     props: Record<string, unknown>;
     meta: Record<string, unknown>;
 }
+export interface CanvasProductAssetData {
+    id: AssetId;
+    type: string;
+    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;
@@ -50,6 +54,7 @@ export interface CanvasProductSessionSnapshot<TToolId extends string = string> {
     currentPageId: string;
     activeToolId: TToolId;
     isToolLocked: boolean;
+    meta: Record<string, unknown>;
     pages: CanvasProductSessionPageState[];
 }
 export interface CanvasProductDocumentRef {
@@ -66,13 +71,39 @@ export interface CanvasProductControllerSnapshot<TToolId extends string = string
     session: CanvasProductSessionSnapshot<TToolId>;
 }
 export type CanvasProductControllerChangeKey = "document" | "session" | "pageId" | "activeToolId" | "selectedShapeIds" | "shapeCount";
-export interface CanvasProductControllerChange<TToolId extends string = string> {
+export interface CanvasProductRealtimeChange<TToolId extends string = string> {
+    delivery: "realtime";
     source: ChangeSource;
     changes: readonly CanvasProductControllerChangeKey[];
     snapshot: CanvasProductControllerSnapshot<TToolId>;
     previousSnapshot: CanvasProductControllerSnapshot<TToolId>;
 }
+export interface CanvasProductCommittedChange<TToolId extends string = string> {
+    delivery: "committed";
+    source: ChangeSource;
+    commit: {
+        id: string;
+        revision: number;
+        kind: string;
+        label: string;
+    };
+    changes: readonly CanvasProductControllerChangeKey[];
+    affectedShapeIds: {
+        added: readonly ShapeId[];
+        updated: readonly ShapeId[];
+        removed: readonly ShapeId[];
+    };
+    snapshot: CanvasProductControllerSnapshot<TToolId>;
+}
+export type CanvasProductControllerChange<TToolId extends string = string> = CanvasProductRealtimeChange<TToolId> | CanvasProductCommittedChange<TToolId>;
 export type CanvasProductControllerChangeListener<TToolId extends string = string> = (change: CanvasProductControllerChange<TToolId>) => void;
+export type CanvasProductSubscriptionOptions = {
+    delivery?: "realtime";
+    scope?: "all" | "document" | "session";
+} | {
+    delivery: "committed";
+    scope: "document";
+};
 export interface CanvasProductLayerNode {
     id: ShapeId;
     parentId: string;
@@ -81,7 +112,6 @@ export interface CanvasProductLayerNode {
     childIds: ShapeId[];
     siblingIndex: number;
     depth: number;
-    displayName: string;
     canReceiveChildren: boolean;
     isHidden: boolean;
     isLocked: boolean;
@@ -119,7 +149,7 @@ export interface CanvasProductCreatePageInput {
 export interface CanvasProductController<TToolId extends string = string> {
     apis: ProductApiRegistry;
     snapshot(): CanvasProductControllerSnapshot<TToolId>;
-    subscribe(listener: CanvasProductControllerChangeListener<TToolId>): () => void;
+    subscribe(listener: CanvasProductControllerChangeListener<TToolId>, options?: CanvasProductSubscriptionOptions): () => void;
     clearHistory(): void;
     canUndo(): boolean;
     canRedo(): boolean;
@@ -127,10 +157,13 @@ export interface CanvasProductController<TToolId extends string = string> {
     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[];
@@ -156,13 +189,10 @@ export interface CanvasProductController<TToolId extends string = string> {
     updatePageMeta(pageId: string, patch: Record<string, unknown>): string | null;
     deletePage(pageId: string): boolean;
     selectPage(pageId: string): void;
-    exportSelectionSvg(): string | null;
-    exportPageSvg(): string | null;
 }
 export interface CanvasProductControllerContext {
     editor: Editor;
     services: ProductServiceRegistry;
-    pluginHostRuntime: unknown;
     apis: ProductApiRegistry;
     productId: string;
 }

package/core/product-controller/index.d.ts

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

package/core/runtime/productAssets.d.ts

@@ -6,13 +6,15 @@ export declare function resolveProductAssetUrl({ assetResolverTokens, assetId, e
     editor: Editor;
     services: ProductServiceRegistry;
 }): string | null;
-export declare function preloadProductAssets({ assetResolverTokens, editor, services, }: {
+export declare function preloadProductAssets({ assetResolverTokens, editor, signal, services, }: {
     assetResolverTokens: readonly ProductServiceToken<ProductAssetResolverService>[];
     editor: Editor;
+    signal: AbortSignal;
     services: ProductServiceRegistry;
 }): Promise<void>;
-export declare function cleanupProductAssetsAfterRestore({ assetResolverTokens, editor, services, }: {
+export declare function cleanupProductAssetsAfterRestore({ assetResolverTokens, editor, signal, services, }: {
     assetResolverTokens: readonly ProductServiceToken<ProductAssetResolverService>[];
     editor: Editor;
+    signal: AbortSignal;
     services: ProductServiceRegistry;
 }): Promise<void>;

package/core/runtime/productEditor.d.ts

@@ -1,3 +1,3 @@
 import { type Editor } from "../../_vendor/canvas-core/index";
-import type { CreateCanvasProductEditorOptions } from "./productDefinition";
+import type { CreateCanvasProductEditorOptions } from "./runtimeContracts";
 export declare function createDefaultCanvasProductEditor(options: CreateCanvasProductEditorOptions): Editor;

package/core/runtime/productServices.d.ts

@@ -1,30 +1,20 @@
 import type { AssetId, Editor } from "../../_vendor/canvas-core/index";
-export interface ProductServiceToken<TService> {
-    readonly id: string;
-    readonly __service?: TService;
-}
-export interface ProductServiceFactoryContext {
-    productId: string;
-}
-export interface ProductServiceFactory<TService> {
-    token: ProductServiceToken<TService>;
-    create(context: ProductServiceFactoryContext): TService;
-    dispose?(service: TService): void;
-}
-export interface ProductServiceRegistry {
-    get<TService>(token: ProductServiceToken<TService>): TService | null;
-}
-export interface ProductServiceRegistryRuntime extends ProductServiceRegistry {
+import { createProductServiceToken, requireProductService, type ProductServiceFactory, type ProductServiceFactoryContext, type ProductServiceRegistry, type ProductServiceSetup, type ProductServiceToken } from "../../_vendor/canvas-plugin-sdk/index";
+export { createProductServiceToken, requireProductService, };
+export type { ProductServiceFactory, ProductServiceFactoryContext, ProductServiceRegistry, ProductServiceSetup, ProductServiceToken, };
+export interface ProductServiceRegistryRuntime extends ProductServiceSetup {
     dispose(): void;
 }
 export interface ProductAssetResolverService {
     resolveAssetUrl(editor: Editor, assetId: AssetId): string | null;
-    preloadForEditor?(editor: Editor): Promise<void>;
-    cleanupAfterRestore?(editor: Editor): Promise<void> | void;
+    preloadForEditor?(editor: Editor, options: {
+        signal: AbortSignal;
+    }): Promise<void>;
+    cleanupAfterRestore?(editor: Editor, options: {
+        signal: AbortSignal;
+    }): Promise<void> | void;
 }
-export declare function createProductServiceToken<TService>(id: string): ProductServiceToken<TService>;
 export declare function createProductServiceRegistry({ factories, productId, }: {
-    factories: readonly ProductServiceFactory<unknown>[];
+    factories?: readonly ProductServiceFactory<unknown>[];
     productId: string;
 }): ProductServiceRegistryRuntime;
-export declare function requireProductService<TService>(services: ProductServiceRegistry, token: ProductServiceToken<TService>): TService;

package/core/runtime/runtimeContracts.d.ts

@@ -0,0 +1,17 @@
+import type { AssetId, DocumentSnapshot, EditorPlugin, SessionSnapshot } from "../../_vendor/canvas-core/index";
+export interface ProductPersistenceLoadResult {
+    documentSnapshot: unknown | null;
+    sessionSnapshot: unknown | null;
+}
+export interface ProductPersistenceAdapter {
+    load?(options: {
+        signal: AbortSignal;
+    }): Promise<ProductPersistenceLoadResult>;
+    saveDocument?(snapshot: DocumentSnapshot): Promise<void>;
+    saveSession?(snapshot: SessionSnapshot): Promise<void>;
+}
+export interface CreateCanvasProductEditorOptions {
+    editorPlugins: readonly EditorPlugin[];
+    documentMeta?: Record<string, unknown>;
+    resolveAssetUrl?: (assetId: AssetId) => string | null;
+}