@yuzhouu/canvas-kit 0.1.9 → 0.1.10

package/browser/localSnapshotRestore.d.ts

@@ -1,13 +0,0 @@
-import { type Editor, type StoreSnapshot } from "../_vendor/canvas-core/index";
-import type { ProductPersistenceRestoreResult } from "../core/runtime/productDefinition";
-export interface PersistedEditorSnapshots {
-    documentSnapshot: unknown | null;
-    sessionSnapshot: unknown | null;
-}
-export interface LocalSnapshotRestoreResult extends ProductPersistenceRestoreResult {
-    preservedUnsupportedRecords: readonly unknown[];
-}
-export declare function restorePersistedEditorSnapshots(editor: Editor, { documentSnapshot, sessionSnapshot }: PersistedEditorSnapshots): LocalSnapshotRestoreResult;
-export declare function getDocumentSnapshotWithPreservedRecords(editor: Editor, preservedRecords: readonly unknown[]): StoreSnapshot<{
-    id: string;
-}>;

package/builtins/extensions.d.ts

@@ -1,18 +0,0 @@
-import type { LandExtensionOptionsInput } from "../_vendor/canvas-react/host/index";
-import { type TextExtensionOptions } from "../_vendor/plugin-text/index";
-export interface BuiltInCanvasExtensionOptions {
-    arrow?: boolean;
-    draw?: boolean;
-    eraser?: boolean;
-    frame?: boolean;
-    geo?: boolean;
-    group?: boolean;
-    image?: boolean;
-    laser?: boolean;
-    path?: boolean;
-    text?: boolean | LandExtensionOptionsInput<TextExtensionOptions>;
-}
-export declare const builtInCanvasExtensions: readonly [import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<TextExtensionOptions>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>, import("../_vendor/canvas-react/host/index").ConfigurableLandExtension<Record<string, never>>];
-export type BuiltInCanvasExtension = (typeof builtInCanvasExtensions)[number];
-export declare function createBuiltInCanvasExtensions(options?: BuiltInCanvasExtensionOptions): readonly BuiltInCanvasExtension[];
-export declare function hasBuiltInCanvasExtension(extensions: readonly BuiltInCanvasExtension[], name: keyof BuiltInCanvasExtensionOptions): boolean;

package/core/runtime/productDefinition.d.ts

@@ -1,33 +0,0 @@
-import type { AssetId, Editor, LandEditorRuntimePlugin } from "../../_vendor/canvas-core/index";
-import type { ProductApiRegistryRuntime } from "../api/apiRegistry";
-import type { ProductPluginHostRuntime } from "./productHost";
-import type { ProductServiceRegistry } from "./productServices";
-export interface ProductPersistenceRestoreResult {
-    autoPersistence: "enabled" | "disabled";
-    status?: ProductPersistenceStatus | null;
-}
-export interface ProductPersistenceStatus {
-    kind: "preserving-unsupported-records";
-    preservedRecordCount: number;
-    unsupportedBindingTypes: readonly string[];
-    unsupportedShapeTypes: readonly string[];
-}
-export interface ProductPersistenceAdapter {
-    restore?(editor: Editor): Promise<ProductPersistenceRestoreResult | void>;
-    start?(editor: Editor): () => void;
-    flushSnapshot?(editor: Editor): Promise<void>;
-    discardUnsupportedRecords?(editor: Editor): Promise<ProductPersistenceRestoreResult | void>;
-}
-export interface CreateCanvasProductEditorOptions {
-    editorRuntimePlugins: readonly LandEditorRuntimePlugin[];
-    documentMeta?: Record<string, unknown>;
-    resolveAssetUrl?: (assetId: AssetId) => string | null;
-}
-export interface CanvasProductRuntimeInitializerContext<TPluginHostRuntime extends ProductPluginHostRuntime = ProductPluginHostRuntime> {
-    productId: string;
-    apis: ProductApiRegistryRuntime;
-    editor: Editor;
-    pluginHostRuntime: TPluginHostRuntime;
-    services: ProductServiceRegistry;
-}
-export type CanvasProductRuntimeInitializer<TPluginHostRuntime extends ProductPluginHostRuntime = ProductPluginHostRuntime> = (context: CanvasProductRuntimeInitializerContext<TPluginHostRuntime>) => void;

package/core/runtime/productHost.d.ts

@@ -1,20 +0,0 @@
-import type { ContextMenuContribution, CanvasAction, ToolbarContribution } from "../../_vendor/canvas-core/index";
-export interface ProductActionRegistry {
-    registerAction(action: CanvasAction): void;
-    registerHostAction(action: CanvasAction): void;
-    getAction(actionId: string): CanvasAction | null;
-    getDuplicateActionIds(): string[];
-}
-export interface ProductToolbarRegistry {
-    registerContribution(contribution: ToolbarContribution): void;
-    getDuplicateContributionIds(): string[];
-}
-export interface ProductContextMenuRegistry {
-    registerContribution(contribution: ContextMenuContribution): void;
-    getDuplicateContributionIds(): string[];
-}
-export interface ProductPluginHostRuntime {
-    actionRegistry: ProductActionRegistry;
-    toolbarRegistry: ProductToolbarRegistry;
-    contextMenuRegistry: ProductContextMenuRegistry;
-}

package/features/clipboard/clipboardHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createClipboardHostExtension(): CanvasKitHostExtension;

package/features/image/imageHostExtension.d.ts

@@ -1,10 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-import { type ImageProductController } from "./controller/imageProductController";
-declare module "../../controller/canvasKitController" {
-    interface CanvasKitControllerSlots {
-        image: ImageProductController | null;
-    }
-}
-export declare function createImageHostExtension(): CanvasKitHostExtension<{
-    image: ImageProductController | null;
-}>;

package/features/keyboard/keyboardShortcutHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createKeyboardShortcutHostExtension(): CanvasKitHostExtension;

package/features/persistence/CanvasKitPersistenceNotice.d.ts

@@ -1,4 +0,0 @@
-import type { CanvasKitPersistenceControls } from "../../chrome/types";
-export declare function CanvasKitPersistenceNotice({ persistence, }: {
-    persistence: CanvasKitPersistenceControls;
-}): import("react/jsx-runtime").JSX.Element | null;

package/features/persistence/persistenceHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createPersistenceHostExtension(): CanvasKitHostExtension;

package/features/selection/selectionHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createSelectionHostExtension(): CanvasKitHostExtension;

package/features/tool/toolHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createToolHostExtension(): CanvasKitHostExtension;

package/features/view/viewHostExtension.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../../runtime/canvasKitHostContracts";
-export declare function createViewHostExtension(): CanvasKitHostExtension;

package/host/defaultHostExtensions.d.ts

@@ -1,2 +0,0 @@
-import type { CanvasKitHostExtension } from "../runtime/canvasKitHostContracts";
-export declare function createCanvasKitHostExtensions(): readonly CanvasKitHostExtension[];

package/product/canvasKitProduct.d.ts

@@ -1,51 +0,0 @@
-import type { LandExtension } from "../_vendor/canvas-react/host/index";
-import type { ReactNode } from "react";
-import type { ProductPersistenceAdapter } from "../core";
-import type { CanvasKitBaseController, CanvasKitController } from "../controller/canvasKitController";
-import { type BuiltInCanvasExtensionOptions } from "../builtins";
-import type { CanvasKitChromeContext } from "../chrome/types";
-import type { CanvasKitHostExtension } from "../runtime/canvasKitHostContracts";
-export declare const CANVAS_KIT_STORAGE_NAMESPACE = "land.canvasKit";
-declare const CANVAS_KIT_PRODUCT_BRAND: unique symbol;
-export type CanvasKitChromeRenderer<TController extends CanvasKitBaseController = CanvasKitController> = (context: CanvasKitChromeContext<TController>) => ReactNode;
-export type CanvasKitDocumentSeed<TController extends CanvasKitBaseController = CanvasKitController> = (controller: TController) => void;
-export type CanvasKitExtensionOptions = BuiltInCanvasExtensionOptions;
-export interface CanvasKitProductOptions<TController extends CanvasKitBaseController = CanvasKitController> {
-    id?: string;
-    chrome?: CanvasKitChromeRenderer<TController>;
-    documentMeta?: Record<string, unknown>;
-    exposeControllerOnWindow?: boolean;
-    onControllerDispose?: () => void;
-    onControllerReady?: (controller: TController) => void;
-    persistence?: ProductPersistenceAdapter | null;
-    seedDocument?: CanvasKitDocumentSeed<TController>;
-    shouldSkipStoredSnapshots?: () => boolean;
-    builtInExtensions?: CanvasKitExtensionOptions;
-    hostExtensions?: readonly CanvasKitHostExtension[];
-    storageNamespace?: string;
-    warnOnPluginRegistrationConflicts?: boolean;
-    windowKey?: string;
-}
-export interface ResolvedCanvasKitConfig<TController extends CanvasKitBaseController = CanvasKitController> {
-    renderChrome?: CanvasKitChromeRenderer<TController>;
-    exposeControllerOnWindow: boolean;
-    onControllerDispose?: () => void;
-    onControllerReady?: (controller: TController) => void;
-    windowKey: string;
-}
-export interface CanvasKitProduct<TController extends CanvasKitBaseController = CanvasKitController> {
-    readonly [CANVAS_KIT_PRODUCT_BRAND]: TController;
-}
-export interface ResolvedCanvasKitProduct<TController extends CanvasKitBaseController = CanvasKitController> extends CanvasKitProduct<TController> {
-    readonly canvasExtensions: readonly LandExtension[];
-    readonly documentMeta?: Record<string, unknown>;
-    readonly id: string;
-    readonly config: ResolvedCanvasKitConfig<TController>;
-    readonly hostExtensions: readonly CanvasKitHostExtension[];
-    readonly persistence: ProductPersistenceAdapter | null;
-    readonly seedDocument?: CanvasKitDocumentSeed<TController>;
-    readonly shouldSkipStoredSnapshots?: () => boolean;
-    readonly warnOnPluginRegistrationConflicts: boolean;
-}
-export declare function defineCanvasKit<TController extends CanvasKitBaseController = CanvasKitController>(options?: CanvasKitProductOptions<TController>): CanvasKitProduct<TController>;
-export {};

package/react/useCanvasKitController.d.ts

@@ -1,5 +0,0 @@
-import { type CanvasKitController, type CanvasKitControllerRuntimeContext, type CanvasKitBaseController } from "../controller/canvasKitController";
-import type { ResolvedCanvasKitConfig } from "../product/canvasKitProduct";
-export declare function useCanvasKitController<TController extends CanvasKitBaseController = CanvasKitController>({ apis, config, controllerSlots, editor, pluginHostRuntime, productId, services, }: CanvasKitControllerRuntimeContext & {
-    config: ResolvedCanvasKitConfig<TController>;
-}): TController;

package/react/useCanvasKitStartup.d.ts

@@ -1,9 +0,0 @@
-import type { CanvasKitController, CanvasKitBaseController } from "../controller/canvasKitController";
-import type { CanvasKitPersistenceControls } from "../chrome/types";
-import type { CanvasKitRuntime } from "../runtime/canvasKitRuntime";
-interface CanvasKitStartup {
-    isReady: boolean;
-    persistence: CanvasKitPersistenceControls;
-}
-export declare function useCanvasKitStartup<TController extends CanvasKitBaseController = CanvasKitController>(runtime: CanvasKitRuntime<TController> | null): CanvasKitStartup;
-export {};

package/runtime/canvasKitHostContracts.d.ts

@@ -1,135 +0,0 @@
-import type { CanvasAction, CanvasActionContext, ContextMenuContribution, Editor, KeyboardShortcutInput, ToolbarContribution } from "../_vendor/canvas-core/index";
-import type { CanvasRenderPluginHostRuntime } from "../_vendor/canvas-react/host/index";
-import type { ComponentType, ReactNode, RefObject } from "react";
-import type { ProductApiRegistryRuntime, ProductApiToken, ProductAssetResolverService, CanvasProductRuntimeInitializer, ProductPersistenceAdapter, ProductServiceFactory, ProductServiceRegistry, ProductServiceToken } from "../core";
-import type { SvgAssetInliner } from "../features/export/svgExport";
-import type { CanvasKitChromeContext, CanvasKitGridControls, CanvasKitPersistenceControls } from "../chrome/types";
-import type { CanvasKitBaseController } from "../controller/canvasKitController";
-export interface CanvasKitHostExtensionContext {
-    canvasExtensionNames: ReadonlySet<string>;
-    persistence: ProductPersistenceAdapter | null;
-    productId: string;
-}
-export interface CanvasKitHostExtension<TControllerSlots extends object = {}, TChromeSlots extends object = {}> {
-    id: string;
-    priority?: number;
-    configure?(options: unknown): CanvasKitHostExtension<TControllerSlots, TChromeSlots>;
-    getExtensions?(): readonly CanvasKitHostExtension[];
-    createFeature(context: CanvasKitHostExtensionContext): CanvasKitHostFeature | null;
-    readonly __controllerSlots?: TControllerSlots;
-    readonly __chromeSlots?: TChromeSlots;
-}
-export interface CanvasKitHostFeature {
-    id: string;
-    priority?: number;
-    requiresCanvasExtensions?: readonly string[];
-    services?: readonly ProductServiceFactory<unknown>[];
-    assetResolverTokens?: readonly ProductServiceToken<ProductAssetResolverService>[];
-    svgAssetInliners?: (context: CanvasKitSvgAssetInlinerContext) => readonly SvgAssetInliner[];
-    actions?: readonly CanvasAction[];
-    createActions?: (context: CanvasKitHostActionContext) => readonly CanvasAction[];
-    actionShortcuts?: readonly CanvasKitActionShortcut[];
-    toolbarContributions?: readonly ToolbarContribution[];
-    contextMenuContributions?: readonly ContextMenuContribution[];
-    canShowToolbarDuringEditing?: (context: CanvasActionContext) => boolean;
-    apis?: readonly CanvasKitHostApiContribution<unknown>[];
-    controllerSlots?: readonly CanvasKitControllerSlot<string, unknown>[];
-    chromeSlots?: readonly CanvasKitChromeSlot<string, unknown>[];
-    providers?: readonly CanvasKitHostProvider[];
-    components?: readonly CanvasKitHostComponent[];
-    onRuntimeInitialize?: CanvasProductRuntimeInitializer<CanvasRenderPluginHostRuntime>;
-    onBeforeStartup?: CanvasKitStartupHook;
-    onAfterRestore?: CanvasKitStartupHook;
-    onBeforeReady?: CanvasKitStartupHook;
-    onRuntimeDispose?: CanvasKitRuntimeDisposeHook;
-    onBeforeCommand?: CanvasKitCommandHook;
-    onAfterCommand?: CanvasKitCommandHook;
-}
-export interface CanvasKitHostActionContext {
-    productId: string;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitHostApiContribution<TApi> {
-    id: string;
-    token: ProductApiToken<TApi>;
-    create(context: CanvasKitHostApiContext): TApi | null;
-}
-export interface CanvasKitHostApiContext {
-    apis: ProductApiRegistryRuntime;
-    editor: Editor;
-    pluginHostRuntime: CanvasRenderPluginHostRuntime;
-    productId: string;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitControllerSlot<TKey extends string, TApi> {
-    key: TKey;
-    token: ProductApiToken<TApi>;
-}
-export interface CanvasKitChromeSlot<TKey extends string, TApi> {
-    key: TKey;
-    token: ProductApiToken<TApi>;
-}
-export interface CanvasKitActionShortcut {
-    actionId: string;
-    shortcut: KeyboardShortcutInput;
-}
-export interface CanvasKitSvgAssetInlinerContext {
-    editor: Editor;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitStartupHookContext {
-    editor: Editor;
-    persistence: ProductPersistenceAdapter | null;
-    productId: string;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitRuntimeDisposeHookContext {
-    editor: Editor;
-    productId: string;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitCommandHookContext {
-    commandId: string;
-    context?: CanvasActionContext;
-    editor: Editor;
-}
-export type CanvasKitStartupHook = (context: CanvasKitStartupHookContext) => Promise<void> | void;
-export type CanvasKitRuntimeDisposeHook = (context: CanvasKitRuntimeDisposeHookContext) => void;
-export type CanvasKitCommandHook = (context: CanvasKitCommandHookContext) => void;
-export interface CanvasKitControllerHostProps {
-    editor: Editor;
-    pluginHostRuntime: CanvasRenderPluginHostRuntime;
-    services: ProductServiceRegistry;
-}
-export interface CanvasKitWorkspaceHostProps extends CanvasKitControllerHostProps {
-    grid: CanvasKitGridControls;
-    isReady: boolean;
-    persistence: CanvasKitPersistenceControls;
-}
-export interface CanvasKitChromeHostProps extends CanvasKitControllerHostProps {
-    chrome: CanvasKitChromeContext<CanvasKitBaseController>;
-    themeRootRef: RefObject<HTMLElement | null>;
-}
-export interface CanvasKitHostProvider {
-    id: string;
-    order?: number;
-    component: ComponentType<{
-        children: ReactNode;
-    }>;
-}
-export type CanvasKitHostComponent = {
-    id: string;
-    slot: "controller";
-    order?: number;
-    component: ComponentType<CanvasKitControllerHostProps>;
-} | {
-    id: string;
-    slot: "workspace";
-    order?: number;
-    component: ComponentType<CanvasKitWorkspaceHostProps>;
-} | {
-    id: string;
-    slot: "chrome";
-    order?: number;
-    component: ComponentType<CanvasKitChromeHostProps>;
-};

package/runtime/canvasKitHostFeatureHooks.d.ts

@@ -1,12 +0,0 @@
-import type { CanvasActionContext, Editor } from "../_vendor/canvas-core/index";
-import type { ProductServiceRegistry } from "../core";
-import type { SvgAssetInliner } from "../features/export/svgExport";
-import type { CanvasKitCommandHookContext, CanvasKitHostFeature } from "./canvasKitHostContracts";
-export declare function getCanvasKitHostFeatureSvgAssetInliners({ editor, hostFeatures, services, }: {
-    editor: Editor;
-    hostFeatures: readonly CanvasKitHostFeature[];
-    services: ProductServiceRegistry;
-}): readonly SvgAssetInliner[];
-export declare function runCanvasKitHostFeaturesBeforeCommand(hostFeatures: readonly CanvasKitHostFeature[], input: CanvasKitCommandHookContext): void;
-export declare function runCanvasKitHostFeaturesAfterCommand(hostFeatures: readonly CanvasKitHostFeature[], input: CanvasKitCommandHookContext): void;
-export declare function canShowCanvasKitToolbarDuringEditing(hostFeatures: readonly CanvasKitHostFeature[], context: CanvasActionContext): boolean;

package/runtime/canvasKitRuntimePlan.d.ts

@@ -1,50 +0,0 @@
-import type { CanvasAction, ContextMenuContribution, ToolbarContribution } from "../_vendor/canvas-core/index";
-import type { CanvasRenderPluginHostRuntime, LandExtension } from "../_vendor/canvas-react/host/index";
-import type { ProductAssetResolverService, ProductServiceFactory, ProductServiceRegistry, ProductServiceToken, CanvasProductRuntimeInitializer } from "../core";
-import type { ResolvedCanvasKitProduct } from "../product/canvasKitProduct";
-import type { CanvasKitBaseController } from "../controller/canvasKitController";
-import type { CanvasKitActionShortcut, CanvasKitChromeSlot, CanvasKitControllerSlot, CanvasKitHostApiContribution, CanvasKitHostComponent, CanvasKitHostFeature, CanvasKitHostProvider, CanvasKitHostExtension, CanvasKitRuntimeDisposeHook, CanvasKitStartupHook } from "./canvasKitHostContracts";
-export interface CanvasKitRuntimePlanDraft {
-    readonly canvasExtensions: readonly LandExtension[];
-    readonly canvasExtensionNames: ReadonlySet<string>;
-    readonly hostExtensions: readonly CanvasKitHostExtension[];
-    readonly hostFeatures: readonly CanvasKitHostFeature[];
-    readonly services: readonly ProductServiceFactory<unknown>[];
-    readonly assetResolverTokens: readonly ProductServiceToken<ProductAssetResolverService>[];
-    readonly actions: readonly CanvasAction[];
-    readonly actionFactories: readonly NonNullable<CanvasKitHostFeature["createActions"]>[];
-    readonly actionShortcuts: readonly CanvasKitActionShortcut[];
-    readonly toolbarContributions: readonly ToolbarContribution[];
-    readonly contextMenuContributions: readonly ContextMenuContribution[];
-    readonly apis: readonly CanvasKitHostApiContribution<unknown>[];
-    readonly controllerSlots: readonly CanvasKitControllerSlot<string, unknown>[];
-    readonly chromeSlots: readonly CanvasKitChromeSlot<string, unknown>[];
-    readonly providers: readonly CanvasKitHostProvider[];
-    readonly components: readonly CanvasKitHostComponent[];
-    readonly componentsBySlot: CanvasKitHostComponentsBySlot;
-    readonly runtimeInitializers: readonly CanvasProductRuntimeInitializer<CanvasRenderPluginHostRuntime>[];
-    readonly beforeStartupHooks: readonly CanvasKitStartupHook[];
-    readonly afterRestoreHooks: readonly CanvasKitStartupHook[];
-    readonly beforeReadyHooks: readonly CanvasKitStartupHook[];
-    readonly runtimeDisposeHooks: readonly CanvasKitRuntimeDisposeHook[];
-}
-export interface CanvasKitRuntimePlan extends Omit<CanvasKitRuntimePlanDraft, "actionFactories"> {
-    readonly knownHostActionIds: readonly string[];
-}
-export interface CanvasKitHostComponentsBySlot {
-    readonly controller: readonly Extract<CanvasKitHostComponent, {
-        slot: "controller";
-    }>[];
-    readonly chrome: readonly Extract<CanvasKitHostComponent, {
-        slot: "chrome";
-    }>[];
-    readonly workspace: readonly Extract<CanvasKitHostComponent, {
-        slot: "workspace";
-    }>[];
-}
-export declare function createCanvasKitRuntimePlan<TController extends CanvasKitBaseController>(product: ResolvedCanvasKitProduct<TController>): CanvasKitRuntimePlanDraft;
-export declare function materializeCanvasKitRuntimePlan({ plan, productId, services, }: {
-    plan: CanvasKitRuntimePlanDraft;
-    productId: string;
-    services: ProductServiceRegistry;
-}): CanvasKitRuntimePlan;