@cratis/event-models 0.112.0 → 0.113.0

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

@@ -0,0 +1,18 @@
+import { ScenePackageBundle } from '@cratis/scene.react';
+import { ResolvedUiProfile } from './ResolvedUiProfile';
+import { UiProfileSettings } from './UiProfileSettings';
+/** The name of the Scene profile the workspace builds. */
+export declare const uiProfileName = "UI Profile";
+/**
+ * Expands the settings into the effective profile.
+ *
+ * Nothing here decides anything itself: `resolvePackageDependencies` expands and orders the packages,
+ * `findComponentCollisions` (`resolveComponentName` over the catalog) says who wins each shared name and
+ * `filterCompatibleThemes` narrows the themes. This function only records, per package, whether the user
+ * chose it and which resolved packages need it - the part a picker has to explain.
+ *
+ * @param settings The settings to resolve.
+ * @param bundles Every known package bundle.
+ * @returns The {@link ResolvedUiProfile}.
+ */
+export declare function resolveUiProfile(settings: UiProfileSettings, bundles: ScenePackageBundle[]): ResolvedUiProfile;

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

@@ -0,0 +1,10 @@
+import { ScenePackageBundle } from '@cratis/scene.react';
+/**
+ * The layout a blueprint contributes as the application shell: the first one its manifest declares.
+ *
+ * @param bundles Every known package bundle.
+ * @param shell The name of the blueprint.
+ * @returns The layout name, or empty when the blueprint is unknown or declares no layout (a template-only
+ * blueprint cannot be the shell).
+ */
+export declare function shellLayoutOf(bundles: ScenePackageBundle[], shell: string): string;

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

@@ -0,0 +1,12 @@
+import { UiProfile } from '@cratis/scene.model';
+import { PersistedUiProfile } from './PersistedUiProfile';
+/**
+ * Builds the Scene profile a stored UI profile stands for, without needing the package catalog.
+ *
+ * This is the one place a consumer other than the UI Profile page should turn the stored profile into a
+ * Scene `UiProfile`, so the screen editor and anything else rendering a screen agree with the preview.
+ *
+ * @param persisted The stored profile.
+ * @returns The Scene {@link UiProfile}.
+ */
+export declare function toSceneUiProfile(persisted: PersistedUiProfile): UiProfile;

package/dist/screen-editor/UiProfileDesigner/filterCompatibleThemes.d.ts

@@ -0,0 +1,12 @@
+import { Theme, UiProfile } from '@cratis/scene.model';
+/**
+ * Filters a theme list down to the ones a {@link UiProfile} can actually pick - part of StudioIssues#160's
+ * theme picker, filtered by the active profile's package list. Reuses `isThemeCompatible` (Cratis/Scene#5)
+ * unmodified as the filter predicate, per the issue's own wording ("reusing the exact compiler
+ * compatibility check as the filter logic rather than duplicating it").
+ *
+ * @param profile The active {@link UiProfile}.
+ * @param themes Every known {@link Theme}.
+ * @returns Only the themes declared compatible with every package `profile` lists.
+ */
+export declare function filterCompatibleThemes(profile: UiProfile, themes: Theme[]): Theme[];

package/dist/screen-editor/UiProfileDesigner/findComponentCollisions.d.ts

@@ -0,0 +1,15 @@
+import { UiProfile } from '@cratis/scene.model';
+import { ComponentResolution, PackageCatalog } from '@cratis/scene.engine';
+/**
+ * Finds every bare component name that more than one of a {@link UiProfile}'s active packages declares -
+ * part of StudioIssues#160's "component name collision surfacing", so the designer can flag which package
+ * currently wins by priority rather than only warning at build time. Reuses `resolveComponentName`
+ * (Cratis/Scene#3) unmodified for every catalog name - a collision is exactly a resolution whose
+ * `shadows` isn't empty, so no separate collision-detection algorithm exists to drift from resolution
+ * itself.
+ *
+ * @param profile The {@link UiProfile} to check.
+ * @param catalog Every active package's declared component names, keyed by package name.
+ * @returns The {@link ComponentResolution} for every bare name declared by more than one active package, sorted by name.
+ */
+export declare function findComponentCollisions(profile: UiProfile, catalog: PackageCatalog): ComponentResolution[];