@cratis/event-models 0.218.2 → 0.220.0

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

@@ -1,5 +1,5 @@
 import { ColorScheme, LayoutMode } from '@cratis/scene.blueprint.default';
-import type { RootTemplate } from '@cratis/scene.model';
+import type { CornerStyle, ProfileIdentity, RootTemplate } from '@cratis/scene.model';
 import type { SampleDataSelectionSettings } from './SampleDataSelectionSettings';
 import type { ProfileSizeClass } from './ProfileSizeClass';
 /**
@@ -32,6 +32,14 @@ export interface UiProfileSettings {
     navigationMode: LayoutMode;
     /** An accent color as `#rrggbb`, or empty to keep the theme's own. */
     accent: string;
+    /** The application's name and logo as Scene models them. Absent for a profile that never chose one: initials taken from the name, name shown. */
+    identity?: ProfileIdentity;
+    /** The corner style. Absent to keep the theme's own corners. */
+    corners?: CornerStyle;
+    /** The id of a font of Scene's font catalog. Absent to keep the theme's own font. */
+    font?: string;
+    /** The menu surface: `light`, `dark` or `primary` (the accent). Absent for light. Stored with the shell's options. */
+    menuTheme?: string;
     /** The screen template new screens start from, or empty for none. Chosen per level by Cratis/StudioIssues#396. */
     defaultScreenTemplate: string;
     /**

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

@@ -1,3 +1,4 @@
+import { UiProfile } from '@cratis/scene.model';
 import { ScenePackageBundle } from '@cratis/scene.react';
 import { ResolvedUiProfile } from './ResolvedUiProfile';
 import { UiProfileSettings } from './UiProfileSettings';
@@ -16,3 +17,13 @@ export declare const uiProfileName = "UI Profile";
  * @returns The {@link ResolvedUiProfile}.
  */
 export declare function resolveUiProfile(settings: UiProfileSettings, bundles: ScenePackageBundle[]): ResolvedUiProfile;
+/**
+ * The profile the preview is drawn from: the resolved profile with the menu mode and menu theme the author chose in the root's options, which is where
+ * Scene reads them. The stored root carries them only once the profile has been saved in the root-template shape, and a profile that chose no root has
+ * none at all; the preview must follow the choice at once, so it is given a root of the layout it resolved to. Only the preview reads this profile.
+ *
+ * @param resolved The resolved profile.
+ * @param settings The settings being designed.
+ * @returns The profile to draw.
+ */
+export declare function previewProfileOf(resolved: ResolvedUiProfile, settings: UiProfileSettings): UiProfile;