@cratis/stage.runtime 4.220.0 → 4.222.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/src/App.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import '@cratis/showrunner.notes.react/styles';
1
2
  import { type ApplicationStructure, type DialogTemplate, type InstanceContribution, type Layout, type NavigationModel, type SceneElement, type Screen, type ScreenTemplate, type Theme, type UiProfile, type ExposureDeclaration } from '@cratis/scene.model';
2
3
  import type { EffectiveNavItem, PackageCatalog } from '@cratis/scene.engine';
3
4
  import { type ComponentRegistry } from '@cratis/scene.react';
@@ -11,6 +12,7 @@ import '@cratis/scene.blueprint.default/styles.css';
11
12
  import { type ApplicationIdentity } from './blueprint';
12
13
  import { type StageResponseContracts } from './stageResponseContracts';
13
14
  import { type StageRouting } from './stageNavigation';
15
+ import { type StageNotesState } from './stageNotes';
14
16
  import './app.css';
15
17
  export interface StageSceneApplication {
16
18
  uiProfiles?: UiProfile[];
@@ -82,3 +84,12 @@ export interface AppProps {
82
84
  isVisible?: (item: EffectiveNavItem) => boolean;
83
85
  }
84
86
  export declare function App({ components, packageCatalog, screenTemplates, dialogTemplates, isVisible, routing }?: AppProps): import("react").JSX.Element;
87
+ /**
88
+ * Tells Arc's application context what is on screen: the screen being shown, and the identifiers the source model gave to its elements.
89
+ * Feedback given anywhere on the screen carries both.
90
+ */
91
+ export declare function StageApplicationContext({ scene, screen, notes }: {
92
+ scene: StageSceneApplication;
93
+ screen: string | undefined;
94
+ notes: StageNotesState;
95
+ }): null;
@@ -6,6 +6,8 @@ export interface StageChromeState {
6
6
  locale: string;
7
7
  setLocale: (locale: string) => void;
8
8
  activity: string;
9
+ /** Whether the host serves the Notes backend, so the feedback button has something to talk to. */
10
+ notesEnabled?: boolean;
9
11
  }
10
12
  /** Provides {@link StageChromeState} to the Stage's own components. */
11
13
  export declare function StageChromeProvider({ state, children }: {
@@ -14,6 +16,8 @@ export declare function StageChromeProvider({ state, children }: {
14
16
  }): import("react").JSX.Element;
15
17
  /** The name the status line is registered under. */
16
18
  export declare const stageActivityComponent = "Stage:activity";
19
+ /** The feedback button in the topbar, rendered only when the host serves Notes; the button hides itself for a user who is signed out. */
20
+ export declare function StageNotes(): import("react").JSX.Element | null;
17
21
  /** The language picker in the topbar, shown only when the model declares more than one. */
18
22
  export declare function StageLocale(): import("react").JSX.Element | null;
19
23
  /**
@@ -5,6 +5,8 @@ import { type ComponentRegistry } from '@cratis/scene.react';
5
5
  export declare const stageLocaleComponent = "Stage:locale";
6
6
  /** The qualified name Stage registers its light/dark toggle under. */
7
7
  export declare const stageThemeToggleComponent = "Stage:themeToggle";
8
+ /** The name the feedback button in the topbar is registered under. */
9
+ export declare const stageNotesComponent = "Stage:notes";
8
10
  /** The package a host renders with when the profile lists no component library: the Cratis component library, built on React Aria. */
9
11
  export declare const stageBaselinePackage = "Cratis.Components";
10
12
  /** The component library the profile opts in to by listing it; the application registers its support only then. */
@@ -8,8 +8,12 @@ export type { StageSource, StageStaticContent } from './stageSource';
8
8
  export type { StageRoutes } from './stageRoutes';
9
9
  export { executeRegisteredCommand, registeredCommand, useStageCommandExecutor } from './commandExecutor';
10
10
  export { hostedBasePath } from './hostedBasePath';
11
+ export { fetchModelReferences, modelReferenceFor, modelReferenceMap } from './modelReferences';
12
+ export type { StageModelReference, StageModelReferenceKind, StageModelReferences } from './modelReferences';
11
13
  export { registeredQuery, performQuery, subscribeQuery, registerQueryRouteResolver } from './queryExecutor';
12
14
  export { StageCommandForm } from './StageCommandForm';
13
15
  export { StageSceneGuardedAction as StageGuardedAction } from './stageData';
14
16
  export { StageDataProvider, useStageData, useStageQuery, dataChanged } from './stageData';
15
17
  export { createStageSliceInvoker, sliceFieldsFrom } from './stageSlices';
18
+ export { readStageNotes } from './stageNotes';
19
+ export type { StageNotesState } from './stageNotes';