@hy-bricks/canvas 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ComponentInstanceHandle } from '@hy-bricks/core';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { ComputedRef } from 'vue';
@@ -484,6 +485,7 @@ export declare type CanvasBindingMode = 'off' | 'data-preview' | 'runtime';
 export declare type CanvasCommandId = 'undo' | 'redo' | 'deleteSelection' | 'duplicateSelection' | 'clearSelection' | 'cancelInteraction' | 'zoomIn' | 'zoomOut' | 'zoom100' | 'resetViewport' | 'fitToContent' | 'fitToSelection' | 'fitToSelectionOrContent' | 'nudgeSelection' | 'nudgeSelectionLarge' | 'lockSelection' | 'unlockSelection' | 'bringForward' | 'sendBackward' | 'bringToFront' | 'sendToBack' | 'toggleGrid' | 'toggleRuler' | (string & {});
 
 export declare interface CanvasContext {
+    readonly canvasId: string;
     document: DocumentStore;
     selection: SelectionStore;
     viewport: ViewportStore;
@@ -523,6 +525,7 @@ export declare interface CanvasContext {
 }
 
 export declare interface CanvasContextOptions {
+    canvasId?: string;
     initialDocument?: PageDocument;
     scheduler?: RenderSchedulerOptions;
     viewport?: ViewportStoreOptions;
@@ -777,11 +780,18 @@ export declare interface CanvasHandle {
     getBindingMode(): CanvasBindingMode;
     testBinding(bindingId: string, mockPayload?: unknown): BindingTestTrace[];
     on<E extends 'binding:fire' | 'binding:error' | 'binding:trace'>(event: E, cb: BindingEventCb<E>): () => void;
+    on<E extends 'instance:ready' | 'instance:unmounted'>(event: E, cb: (instanceId: string) => void): () => void;
+    getInstanceRuntime(instanceId: string): ComponentInstanceHandle | null;
+    getInstanceReady(instanceId: string): Promise<void>;
     startTracing(opts?: TraceCollectorOptions): void;
     stopTracing(): BindingTraceEvent[];
     getTraceBuffer(): readonly BindingTraceEvent[];
     invalidateDataSource(sourceId?: string): void;
     getDataSourceSnapshot(): DataSourceSnapshot;
+    getCachedBySourceId(sourceId: string, params?: Record<string, unknown>): {
+        value: unknown;
+        status: DataSourceStatus;
+    } | undefined;
     attachBindingDelegate(delegate: WirePageBindingsHandle | null, dataStore?: DataSourceStore | null): void;
 }
 
@@ -1142,6 +1152,10 @@ declare interface DataSourceStore {
     }): void;
     invalidate(sourceId?: string): void;
     getSnapshot(): DataSourceSnapshot;
+    getCachedBySourceId(sourceId: string, params?: Record<string, unknown>): {
+        value: unknown;
+        status: DataSourceStatus;
+    } | undefined;
     disposeAll(): void;
     readonly isDisposed: boolean;
     attachTraceBridge(cb: (ev: StoreTraceEvent) => void): () => void;
@@ -1345,6 +1359,10 @@ export declare interface GridContainerLayout {
     }>;
 }
 
+export declare class HandleDisposedError extends Error {
+    constructor(message?: string);
+}
+
 export declare function hitTestInstance(canvasPt: Point, instances: readonly PageInstance[], domBoxLookup?: (instanceId: string) => Rect | null): string | null;
 
 export declare const HyperCardCanvasDesigner: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
@@ -1354,6 +1372,10 @@ binding: ShallowRef<WirePageBindingsHandle | null, WirePageBindingsHandle | null
 data: {
 invalidateDataSource(sourceId?: string): void;
 getDataSourceSnapshot(): DataSourceSnapshot;
+getCachedBySourceId(sourceId: string, params?: Record<string, unknown>): {
+value: unknown;
+status: DataSourceStatus;
+} | undefined;
 } | null;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
 rootEl: HTMLDivElement;
@@ -1363,6 +1385,10 @@ export declare interface HyperCardPageRendererExpose {
     data: {
         invalidateDataSource(sourceId?: string): void;
         getDataSourceSnapshot(): DataSourceSnapshot;
+        getCachedBySourceId(sourceId: string, params?: Record<string, unknown>): {
+            value: unknown;
+            status: DataSourceStatus;
+        } | undefined;
     } | null;
     binding: WirePageBindingsHandle | null;
 }