@cratis/event-models 0.133.0 → 0.134.0

package/dist/Board/BoardEditing.d.ts

@@ -9,6 +9,9 @@ export interface BoardEditing extends SpecificationEditing, StickyNoteChanges {
     onSliceStatusChanged?: (sliceId: Guid, status: SliceStatus) => Promise<boolean | void> | void;
     onTranslationDirectionChanged?: (sliceId: Guid, direction: TranslationDirection) => Promise<boolean | void> | void;
     onSliceAdded?: (afterSliceId: Guid, sliceType: SliceType) => void;
+    onFeatureAdded?: (moduleId: Guid) => void;
+    onSubFeatureAdded?: (featureId: Guid) => void;
+    onSliceAddedToFeature?: (featureId: Guid, sliceType: SliceType) => void;
     onEventAdded?: (sliceId: Guid) => void;
     onEventReferenced?: (sliceId: Guid, source: EventItem) => void;
     onEventRenamed?: (sliceId: Guid, eventId: Guid, name: string) => string | void;

package/dist/Board/EventModelBoardHandle.d.ts

@@ -1,5 +1,7 @@
 import type { Position } from '../Model';
+import type { EventModelImageExportOptions } from './EventModelImageExportOptions';
 export interface EventModelBoardHandle {
     addCollection(x: number, y: number): Promise<void>;
     addStickyNote(center: Position): void;
+    exportImage(options?: EventModelImageExportOptions): Promise<Blob>;
 }

package/dist/Board/EventModelImageExportOptions.d.ts

@@ -0,0 +1,5 @@
+export interface EventModelImageExportOptions {
+    scale?: number;
+    background?: string;
+    padding?: number;
+}

package/dist/Board/captureBoardImage.d.ts

@@ -0,0 +1,11 @@
+import type { ReactElement } from 'react';
+export declare const EXPORT_EXCLUDE_ATTRIBUTE = "data-event-model-export-exclude";
+export interface BoardImageCaptureEnvironment {
+    createContainer: (width: number, height: number, padding: number) => HTMLElement;
+    removeContainer: (container: HTMLElement) => void;
+    mount: (container: HTMLElement, element: ReactElement) => () => void;
+    waitForLayoutToSettle: () => Promise<void>;
+    captureBlob: (container: HTMLElement, pixelRatio: number, backgroundColor: string) => Promise<Blob | null>;
+}
+export declare const defaultBoardImageCaptureEnvironment: BoardImageCaptureEnvironment;
+export declare function captureBoardImage(element: ReactElement, width: number, height: number, padding: number, pixelRatio: number, backgroundColor: string, environment?: BoardImageCaptureEnvironment): Promise<Blob>;

package/dist/Board/contentBoundingBox.d.ts

@@ -0,0 +1,13 @@
+import type { Position } from '../Model';
+export interface ContentBoundingBox {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export declare function contentBoundingBox<T extends {
+    position: Position;
+}>(collections: readonly T[], estimateSize: (collection: T) => {
+    width: number;
+    height: number;
+}): ContentBoundingBox;

package/dist/Board/exportBoardImage.d.ts

@@ -0,0 +1,17 @@
+import type { Guid } from '@cratis/fundamentals';
+import type { CollectionSizeEstimate } from '../Collections';
+import type { ModuleCollectionLink, StickyNote } from '../Model';
+import type { BoardCollection, BoardCollections } from './BoardCollections';
+import { captureBoardImage } from './captureBoardImage';
+import type { EventModelImageExportOptions } from './EventModelImageExportOptions';
+export interface ExportBoardImageParams<T extends BoardCollection> {
+    documentId: Guid;
+    collections: readonly T[];
+    estimateSize: (collection: T) => CollectionSizeEstimate;
+    countSlices: (collection: T) => number;
+    renderCollection: BoardCollections<T>['renderCollection'];
+    links: ModuleCollectionLink[];
+    stickyNotes: readonly StickyNote[];
+    options?: EventModelImageExportOptions;
+}
+export declare function exportBoardImage<T extends BoardCollection>(params: ExportBoardImageParams<T>, capture?: typeof captureBoardImage): Promise<Blob>;

package/dist/Board/exportImageLayout.d.ts

@@ -0,0 +1,9 @@
+import type { Position } from '../Model';
+import type { ContentBoundingBox } from './contentBoundingBox';
+export interface ExportImageLayout {
+    canvasWidth: number;
+    canvasHeight: number;
+    canvasInitialZoom: number;
+    canvasInitialPan: Position;
+}
+export declare function exportImageLayout(boundingBox: ContentBoundingBox): ExportImageLayout;

package/dist/Board/index.d.ts

@@ -12,6 +12,11 @@ export * from './EventModelBoard';
 export * from './EventModelBoardEditor';
 export * from './EventModelBoardHandle';
 export * from './BoardCollections';
+export * from './captureBoardImage';
+export * from './contentBoundingBox';
+export * from './EventModelImageExportOptions';
+export * from './exportBoardImage';
+export * from './exportImageLayout';
 export * from './HostedEventModelBoard';
 export * from './boardMinimap';
 export * from './isLargeBoard';
@@ -21,3 +26,4 @@ export * from './BoardViewOptions';
 export * from './BoardOverlay';
 export * from './EditToolbar';
 export * from './nextModulePosition';
+export * from './structuralAddCallbacks';

package/dist/Board/structuralAddCallbacks.d.ts

@@ -0,0 +1,8 @@
+import type { Guid } from '@cratis/fundamentals';
+import type { SliceType } from '../Model';
+import type { BoardEditing } from './BoardEditing';
+export declare const featureAddCallback: (moduleId: Guid, supplied: (() => void) | undefined, editing: BoardEditing) => (() => void) | undefined;
+export declare const featureStructuralAddCallbacks: (featureId: Guid, onAddSubFeature: (() => void) | undefined, onAddSlice: ((sliceType: SliceType) => void) | undefined, editing: BoardEditing) => {
+    onAddSubFeature: (() => void) | undefined;
+    onAddSlice: ((sliceType: SliceType) => void) | undefined;
+};