@cratis/event-models 0.184.0 → 0.185.0

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

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

package/dist/screen-editor/UiProfile/SampleDataSelectionSettings.d.ts

@@ -0,0 +1,13 @@
+import type { SampleDataMapping } from '@cratis/scene.model';
+/**
+ * The sample data an application uses, chosen once in the UI Profile setup and inherited everywhere: the active pack,
+ * and the shape to read model mappings that go with it. It is the `sampleData` of Scene's `UiProfile`.
+ */
+export interface SampleDataSelectionSettings {
+    /** The active pack's identifier - an own pack or a blueprint's - or empty for the generated data. */
+    activePack: string;
+    /** The shapes the pack names that stand in for a read model of another name. */
+    mappings: SampleDataMapping[];
+}
+/** No pack chosen, no mappings: the generated, deterministic data. */
+export declare const noSampleData: SampleDataSelectionSettings;

package/dist/screen-editor/UiProfile/UiProfileSettings.d.ts

@@ -1,4 +1,5 @@
 import { ColorScheme, LayoutMode } from '@cratis/scene.blueprint.default';
+import type { SampleDataSelectionSettings } from './SampleDataSelectionSettings';
 /**
  * The choices that make up an application's UI profile - what a draft edits and what applying persists.
  *
@@ -26,4 +27,9 @@ export interface UiProfileSettings {
     accent: string;
     /** The screen template new screens start from, or empty for none. Chosen per level by Cratis/StudioIssues#396. */
     defaultScreenTemplate: string;
+    /**
+     * The sample data every preview and run of the application uses: chosen once here (the user's own pack or a blueprint's)
+     * and inherited everywhere, never per screen. Absent for a profile stored before sample data existed: generated data.
+     */
+    sampleData?: SampleDataSelectionSettings;
 }

package/dist/screen-editor/UiProfile/sampleDataOf.d.ts

@@ -0,0 +1,27 @@
+import type { SampleDataSelection } from '@cratis/scene.model';
+import { SampleDataSelectionSettings } from './SampleDataSelectionSettings';
+import { UiProfileSettings } from './UiProfileSettings';
+/**
+ * The sample data choice of settings, which a profile stored before sample data existed does not have.
+ *
+ * @param settings The settings.
+ * @returns The choice; generated data when none was made.
+ */
+export declare const sampleDataOf: (settings: Pick<UiProfileSettings, 'sampleData'>) => SampleDataSelectionSettings;
+/**
+ * Whether two sample data choices are the same.
+ *
+ * @param left The first choice.
+ * @param right The second choice.
+ * @returns `true` when the same pack is active with the same mappings, whatever their order.
+ */
+export declare const areSampleDataEqual: (left: SampleDataSelectionSettings, right: SampleDataSelectionSettings) => boolean;
+/**
+ * The Scene `sampleData` of a profile for a choice: what Stage, the CLI and the screen editor read to resolve the data, so Studio
+ * keeps no separate notion of it. Nothing is returned for the generated data with no mappings - the profile then has no `sampleData`
+ * at all, as one declared without it has.
+ *
+ * @param selection The choice.
+ * @returns The Scene selection, or `undefined` when the choice declares nothing.
+ */
+export declare const toSceneSampleData: (selection: SampleDataSelectionSettings | undefined) => SampleDataSelection | undefined;

package/dist/screen-editor/UiProfile/toSceneUiProfile.d.ts

@@ -1,5 +1,6 @@
 import { UiProfile } from '@cratis/scene.model';
 import { PersistedUiProfile } from './PersistedUiProfile';
+import type { SampleDataSelectionSettings } from './SampleDataSelectionSettings';
 /**
  * Builds the Scene profile a stored UI profile stands for, without needing the package catalog.
  *
@@ -7,6 +8,7 @@ import { PersistedUiProfile } from './PersistedUiProfile';
  * Scene `UiProfile`, so the screen editor and anything else rendering a screen agree with the preview.
  *
  * @param persisted The stored profile.
+ * @param sampleData The application's sample data choice, stored apart from the profile; absent when none was made.
  * @returns The Scene {@link UiProfile}.
  */
-export declare function toSceneUiProfile(persisted: PersistedUiProfile): UiProfile;
+export declare function toSceneUiProfile(persisted: PersistedUiProfile, sampleData?: SampleDataSelectionSettings): UiProfile;