@cratis/event-models 0.114.1 → 0.115.0

package/dist/screen-editor/ScreenEditor/Document/canvasMoveEdits.d.ts

@@ -1,4 +1,9 @@
 import { type SceneEdit, type SceneElement } from '@cratis/scene.model';
 import type { StructureEdit } from '../Structure/StructureEdit';
-import { type CanvasPlacement } from './placeOnCanvas';
-export declare function canvasMoveEdits(roots: readonly SceneElement[], edit: StructureEdit, at?: CanvasPlacement): SceneEdit[] | undefined;
+import { type CanvasPlacement, type PlacedBox } from './placeOnCanvas';
+export declare const boxesOn: (canvas: SceneElement | undefined, measure?: BoxMeasure) => PlacedBox[];
+export type BoxMeasure = (elementId: string, canvasId: string) => {
+    height: number;
+    bottom: number;
+} | undefined;
+export declare function canvasMoveEdits(roots: readonly SceneElement[], edit: StructureEdit, at?: CanvasPlacement, measure?: BoxMeasure): SceneEdit[] | undefined;

package/dist/screen-editor/ScreenEditor/Document/placeOnCanvas.d.ts

@@ -3,8 +3,14 @@ export interface CanvasPlacement {
     left: number;
     top: number;
 }
-export declare const canvasCascadeStep = 32;
-export declare const cascadedPlacement: (siblings: number) => CanvasPlacement;
+export declare const canvasGap = 16;
+export declare const nominalElementHeight = 40;
+export interface PlacedBox {
+    placement?: CanvasPlacement;
+    height?: number;
+    bottom?: number;
+}
+export declare function placementBelow(existing: readonly PlacedBox[]): CanvasPlacement;
 export declare function placeOnCanvas<T extends SceneElement>(element: T, placement: CanvasPlacement): T;
 export declare function placementOf(element: SceneElement): CanvasPlacement | undefined;
 export declare function removePlacement<T extends SceneElement>(element: T): T;

package/dist/screen-editor/ScreenEditor/Host/ScreenEditorController.d.ts

@@ -8,6 +8,12 @@ import type { StructureTreeAdapter } from '../Structure/StructureTreeAdapter';
 import type { EditorComposition } from '../Templates/composeEditorScreen';
 import type { DropRegion } from '../DropRegions/DropRegion';
 import type { LayoutItem } from '../Layouts/LayoutItem';
+export type ElementMeasurer = (elementId: string) => {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+} | undefined;
 export interface ScreenEditorController {
     document: SceneDocument;
     composition: EditorComposition;
@@ -20,6 +26,7 @@ export interface ScreenEditorController {
     ownershipOf: (elementId: string) => Ownership;
     dropRegions: readonly DropRegion[];
     select: (elementId: string | undefined) => void;
+    setMeasurer: (measure: ElementMeasurer | undefined) => void;
     apply: (edit: SceneEdit, label: string) => void;
     tryApply: (edit: SceneEdit, label: string) => {
         applied: boolean;

package/dist/screen-editor/ScreenEditor/Host/ScreenEditorOverlay.d.ts

@@ -3,6 +3,7 @@ import type { ScreenEditorStrings } from '../Inspector/ScreenEditorStrings';
 import { type PaletteIcons, type PaletteSource } from '../Palette/buildPalette';
 import type { LayoutLabels } from '../Layouts/toLayoutContainerDescriptors';
 import type { ScreenEditorEnvironment, ScreenEditorResult, ScreenEditorSubject } from './ScreenEditorHost';
+import { type WindowSizeMemory } from '../Viewport/windowSizeMemory';
 export interface ScreenEditorOverlayProps {
     subject: ScreenEditorSubject;
     environment: ScreenEditorEnvironment;
@@ -15,6 +16,8 @@ export interface ScreenEditorOverlayProps {
         width: number;
         height: number;
     };
+    rememberWindowAs?: string;
+    windowMemory?: WindowSizeMemory;
     centerOffsetX?: number;
     renderPaletteHost?: (palette: ReactNode) => ReactNode;
     onClose: (result: ScreenEditorResult) => void;

package/dist/screen-editor/ScreenEditor/Play/PlayScreen.d.ts

@@ -0,0 +1,11 @@
+import { type ComponentRegistry } from '@cratis/scene.react';
+import type { BindingResolver } from '@cratis/scene.engine';
+import type { SceneDocument } from '@cratis/scene.model';
+import type { ScreenEditorRuntime } from '../Runtime/screenEditorRuntime';
+export interface PlayScreenViewProps {
+    document: SceneDocument;
+    runtime: ScreenEditorRuntime;
+    resolveBinding: BindingResolver;
+    registry?: ComponentRegistry;
+}
+export declare const PlayScreenView: ({ document, runtime, resolveBinding, registry }: PlayScreenViewProps) => import("react").JSX.Element;

package/dist/screen-editor/ScreenEditor/Play/composePlayScreen.d.ts

@@ -0,0 +1,7 @@
+import type { EffectiveConfiguration, SceneDocument, SceneElement } from '@cratis/scene.model';
+import { type DescriptorCatalog } from '@cratis/scene.engine';
+export interface PlayScreen {
+    element: SceneElement;
+    configuration?: EffectiveConfiguration;
+}
+export declare function composePlayScreen(document: SceneDocument, catalog: DescriptorCatalog): PlayScreen;

package/dist/screen-editor/ScreenEditor/Runtime/ScreenEditorAppearance.d.ts

@@ -0,0 +1,4 @@
+import type { Theme } from '@cratis/scene.model';
+export interface ScreenEditorAppearance {
+    theme: Theme;
+}

package/dist/screen-editor/ScreenEditor/Runtime/profileTheme.d.ts

@@ -1,3 +1,3 @@
 import type { Theme } from '@cratis/scene.model';
 import type { ScreenEditorRuntime } from './screenEditorRuntime';
-export declare function profileTheme(runtime: Pick<ScreenEditorRuntime, 'bundles' | 'profile'>): Theme | undefined;
+export declare function profileTheme(runtime: Pick<ScreenEditorRuntime, 'bundles' | 'profile'> & Partial<Pick<ScreenEditorRuntime, 'appearance'>>): Theme | undefined;

package/dist/screen-editor/ScreenEditor/Runtime/screenEditorRuntime.d.ts

@@ -1,6 +1,7 @@
 import { type DescriptorCatalog, type EffectiveIconCatalog, type PackageCatalog } from '@cratis/scene.engine';
 import type { ComponentDescriptor, UiProfile } from '@cratis/scene.model';
 import { type ComponentRegistry, type IconAdapterRegistry, type ScenePackageBundle } from '@cratis/scene.react';
+import type { ScreenEditorAppearance } from './ScreenEditorAppearance';
 export interface ScreenEditorRuntime {
     id: number;
     bundles: ScenePackageBundle[];
@@ -9,9 +10,10 @@ export interface ScreenEditorRuntime {
     descriptors: ComponentDescriptor[];
     catalog: DescriptorCatalog;
     profile: UiProfile;
+    appearance?: ScreenEditorAppearance;
     icons: EffectiveIconCatalog;
     iconAdapters: IconAdapterRegistry;
     isKnownComponent: (bareName: string) => boolean;
     legacyTypeOf: (componentName: string) => string | undefined;
 }
-export declare function createScreenEditorRuntime(bundles: ScenePackageBundle[], profile: UiProfile): ScreenEditorRuntime;
+export declare function createScreenEditorRuntime(bundles: ScenePackageBundle[], profile: UiProfile, appearance?: ScreenEditorAppearance): ScreenEditorRuntime;

package/dist/screen-editor/ScreenEditor/Runtime/screenEditorRuntimeForProfile.d.ts

@@ -1,4 +1,5 @@
 import type { ScenePackageBundle } from '@cratis/scene.react';
 import type { PersistedUiProfile } from '../../UiProfile/PersistedUiProfile';
+import type { ScreenEditorAppearance } from './ScreenEditorAppearance';
 import { type ScreenEditorRuntime } from './screenEditorRuntime';
-export declare function screenEditorRuntimeForProfile(applied?: PersistedUiProfile, bundles?: ScenePackageBundle[]): ScreenEditorRuntime;
+export declare function screenEditorRuntimeForProfile(applied?: PersistedUiProfile, bundles?: ScenePackageBundle[], appearance?: ScreenEditorAppearance): ScreenEditorRuntime;

package/dist/screen-editor/ScreenEditor/Surface/designTimePointer.d.ts

@@ -0,0 +1,9 @@
+export declare const designTimePointerEvents: readonly ['pointerdown', 'pointerup', 'mousedown', 'mouseup', 'click', 'dblclick'];
+export declare const elementHitSelector = "[data-scene-id], [data-studio-element], [data-studio-placeholder-for]";
+export interface DesignTimePointerDecision {
+    select: boolean;
+    swallow: boolean;
+    cancelDefault: boolean;
+}
+export declare function decideDesignTimePointer(type: string, target: EventTarget | null, button?: number): DesignTimePointerDecision;
+export declare function elementIdAt(target: EventTarget | null): string | undefined;

package/dist/screen-editor/ScreenEditor/Surface/useDesignTimePointer.d.ts

@@ -0,0 +1,2 @@
+import { type RefObject } from 'react';
+export declare function useDesignTimePointer(surface: RefObject<HTMLElement | null>, select: (id: string | undefined) => void): void;

package/dist/screen-editor/ScreenEditor/Thumbnail/ScreenThumbnail.d.ts

@@ -0,0 +1,15 @@
+import { type MouseEvent, type ReactNode } from 'react';
+import type { SceneDocument } from '@cratis/scene.model';
+import type { ScreenEditorRuntime } from '../Runtime/screenEditorRuntime';
+import type { ViewportSize } from '../Viewport/ViewportSize';
+export interface ScreenThumbnailProps {
+    document: SceneDocument;
+    runtime: ScreenEditorRuntime;
+    windowSize?: ViewportSize;
+    width?: number;
+    title?: string;
+    openTitle?: string;
+    onClick?: (event: MouseEvent<HTMLElement>) => void;
+    placeholder?: ReactNode;
+}
+export declare const ScreenThumbnail: ({ document, runtime, windowSize, width, title, openTitle, onClick, placeholder }: ScreenThumbnailProps) => import("react").JSX.Element;

package/dist/screen-editor/ScreenEditor/Thumbnail/miniatureRegistry.d.ts

@@ -0,0 +1,3 @@
+import type { ComponentRegistry } from '@cratis/scene.react';
+export declare const drawsNothingInAMiniature: (componentName: string) => boolean;
+export declare function miniatureRegistry(registry: ComponentRegistry): ComponentRegistry;

package/dist/screen-editor/ScreenEditor/Thumbnail/readThumbnailDocument.d.ts

@@ -0,0 +1,2 @@
+import type { SceneDocument } from '@cratis/scene.model';
+export declare function readThumbnailDocument(text: string | undefined): SceneDocument | undefined;

package/dist/screen-editor/ScreenEditor/Thumbnail/thumbnailGeometry.d.ts

@@ -0,0 +1,11 @@
+import type { ViewportSize } from '../Viewport/ViewportSize';
+export interface ThumbnailGeometry {
+    canvasWidth: number;
+    canvasHeight: number;
+    width: number;
+    bodyHeight: number;
+    scale: number;
+}
+export declare const thumbnailWidth = 240;
+export declare const thumbnailMaxBodyHeight = 112;
+export declare function thumbnailGeometry(windowSize: ViewportSize | undefined, width?: number, maxBodyHeight?: number): ThumbnailGeometry;

package/dist/screen-editor/ScreenEditor/Thumbnail/useIsNearViewport.d.ts

@@ -0,0 +1,2 @@
+import { type RefObject } from 'react';
+export declare function useIsNearViewport(target: RefObject<Element | null>, margin?: number): boolean;

package/dist/screen-editor/ScreenEditor/Viewport/windowSizeMemory.d.ts

@@ -0,0 +1,12 @@
+import type { ViewportSize } from './ViewportSize';
+export interface WindowSizeStorage {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+}
+export interface WindowSizeMemory {
+    read(screen: string): ViewportSize | undefined;
+    write(screen: string, size: ViewportSize): void;
+    readLastUsed(): ViewportSize | undefined;
+}
+export declare const browserWindowSizeStorage: () => WindowSizeStorage | undefined;
+export declare function createWindowSizeMemory(storage?: WindowSizeStorage | undefined): WindowSizeMemory;

package/dist/screen-editor/ScreenEditor/Viewport/windowSizing.d.ts

@@ -0,0 +1,10 @@
+import type { ViewportSize } from './ViewportSize';
+export declare function defaultWindowSize(available: ViewportSize): ViewportSize;
+export declare function isLegacyDefaultWindow(size: ViewportSize | undefined): boolean;
+export interface WindowSizeCandidates {
+    remembered?: ViewportSize;
+    saved?: ViewportSize;
+    lastUsed?: ViewportSize;
+}
+export declare function resolveInitialWindowSize(candidates: WindowSizeCandidates, available: ViewportSize): ViewportSize;
+export declare function fitWindowSize(size: ViewportSize, available: ViewportSize): ViewportSize;

package/dist/screen-editor/ScreenEditor/index.d.ts

@@ -6,9 +6,17 @@ export * from './Host/ScreenEditorWindow';
 export * from './Host/ScreenEditorController';
 export * from './Host/ScreenEditorHost';
 export * from './Host/ScreenEditorFileUpload';
+export * from './Host/ScreenEditorControlProviders';
 export * from './Host/createScreenEditorEnvironment';
 export * from './Runtime/screenEditorRuntime';
 export * from './Runtime/screenEditorRuntimeForProfile';
+export * from './Runtime/ScreenEditorAppearance';
+export * from './Play/PlayScreen';
+export * from './Thumbnail/ScreenThumbnail';
+export * from './Thumbnail/readThumbnailDocument';
+export * from './Thumbnail/thumbnailGeometry';
+export * from './Viewport/windowSizeMemory';
+export * from './Viewport/windowSizing';
 export * from './Inspector/ScreenEditorStrings';
 export * from './Defaults/defaultScreenEditorStrings';
 export * from './PropertyEditors/Json/JsonPropertyField';