@cohesivesystems/presentation-react 0.1.0-alpha.1

package/src/local-flow-state-data-source-projection.ts

@@ -0,0 +1,133 @@
+import {
+  createPresentationEnumDiscriminator,
+  findPresentationView,
+  matchesPresentationEnum,
+  presentationDataSourceBindings,
+  resolvePresentationViewDataSourceIds,
+  type PresentationDataSourceAuthorizationRequirement,
+  type PresentationDataSourceBinding,
+  type PresentationModuleDefinition,
+  type ViewDefinition,
+} from '@cohesivesystems/presentation-core'
+import type { PresentationFlowRuntimeEntry } from './presentation-flow-runtime'
+import { viewSubjectKinds } from '@cohesivesystems/presentation-contracts'
+
+export interface LocalFlowStateDataSourceState {
+  readonly data?: unknown
+  readonly error?: unknown
+  readonly isFetching?: boolean
+  readonly isPending?: boolean
+}
+
+export function createLocalFlowStateDataSourceBindings({
+  activeEntries,
+  authorization,
+  module,
+  state,
+  statesByFlowId,
+}: {
+  readonly activeEntries: readonly PresentationFlowRuntimeEntry[]
+  readonly authorization: PresentationDataSourceAuthorizationRequirement
+  readonly module: PresentationModuleDefinition | null
+  readonly state?: LocalFlowStateDataSourceState | null
+  readonly statesByFlowId?: Readonly<Record<string, LocalFlowStateDataSourceState | null | undefined>>
+}): readonly PresentationDataSourceBinding[] {
+  return activeEntries.flatMap((entry) => {
+    const flowState = statesByFlowId?.[entry.flow.Id] ?? state
+    const dataSourceIds = resolveLocalFlowStateDataSourceIds({
+      flowId: entry.flow.Id,
+      module,
+      view: entry.view,
+    })
+
+    return dataSourceIds.map((dataSourceId) =>
+      presentationDataSourceBindings.localValue({
+        authorization,
+        data: flowState?.data ?? null,
+        dataSourceId,
+        error: flowState?.error,
+        isFetching: flowState?.isFetching,
+        isPending: flowState?.isPending,
+      }),
+    )
+  })
+}
+
+export function resolveLocalFlowStateDataSourceIds({
+  flowId,
+  module,
+  view,
+}: {
+  readonly flowId: string
+  readonly module: PresentationModuleDefinition | null
+  readonly view: ViewDefinition | null
+}) {
+  if (!module || !view) {
+    return []
+  }
+
+  const dataSourceIds = new Set<string>()
+  const visitedViewIds = new Set<string>()
+  collectLocalFlowStateDataSourceIds({
+    dataSourceIds,
+    flowId,
+    module,
+    view,
+    visitedViewIds,
+  })
+  return Array.from(dataSourceIds)
+}
+
+function collectLocalFlowStateDataSourceIds({
+  dataSourceIds,
+  flowId,
+  module,
+  view,
+  visitedViewIds,
+}: {
+  readonly dataSourceIds: Set<string>
+  readonly flowId: string
+  readonly module: PresentationModuleDefinition
+  readonly view: ViewDefinition
+  readonly visitedViewIds: Set<string>
+}) {
+  if (visitedViewIds.has(view.Id)) {
+    return
+  }
+
+  visitedViewIds.add(view.Id)
+  if (isLocalFlowStateView(view, flowId)) {
+    for (const dataSourceId of resolvePresentationViewDataSourceIds(view)) {
+      dataSourceIds.add(dataSourceId)
+    }
+  }
+
+  for (const region of view.Regions) {
+    for (const viewId of region.ViewIds) {
+      const childView = findPresentationView<ViewDefinition>(module, viewId)
+      if (childView) {
+        collectLocalFlowStateDataSourceIds({
+          dataSourceIds,
+          flowId,
+          module,
+          view: childView,
+          visitedViewIds,
+        })
+      }
+    }
+  }
+}
+
+function isLocalFlowStateView(view: ViewDefinition, flowId: string) {
+  return (
+    view.Subject.FlowId === flowId &&
+    matchesPresentationEnum(
+      view.Subject.Kind,
+      createPresentationEnumDiscriminator(
+        viewSubjectKinds,
+        'localFlowState',
+        'LocalFlowState',
+      ),
+    )
+  )
+}

package/src/navigation-runtime-context.ts

@@ -0,0 +1,40 @@
+import { createContext, useContext } from 'react'
+
+import type {
+  PresentationNavigationRuntime,
+} from '@cohesivesystems/presentation-core'
+
+/**
+ * Re-exports the core navigation runtime contracts used by React navigation
+ * providers and projected components.
+ */
+export type {
+  PresentationHrefNavigator,
+  PresentationNavigationHrefFactory,
+  PresentationNavigationRuntime,
+  PresentationRouteNavigator,
+} from '@cohesivesystems/presentation-core'
+
+/**
+ * React context carrying navigation services for projected presentation
+ * components.
+ *
+ * The default runtime is intentionally inert so components can render in tests,
+ * previews, and partially wired hosts without failing at context-read time.
+ */
+export const PresentationNavigationRuntimeContext =
+  createContext<PresentationNavigationRuntime>({
+    createHref: () => null,
+    navigateHref: () => undefined,
+    navigateRoute: () => undefined,
+  })
+
+/**
+ * Reads the active presentation navigation runtime from React context.
+ *
+ * Components should use this hook instead of importing a concrete router so the
+ * same projected UI can run under different host navigation adapters.
+ */
+export function usePresentationNavigationRuntime() {
+  return useContext(PresentationNavigationRuntimeContext)
+}

package/src/navigation-shell-frame-renderer-registry.ts

@@ -0,0 +1,54 @@
+import type { ReactNode } from 'react'
+
+import type {
+  NavigationDefinition,
+  NavigationNodeDefinition,
+  NavigationShellKind,
+  NavigationShellRegionDefinition,
+  NavigationShellSlotDefinition,
+} from '@cohesivesystems/presentation-contracts'
+import {
+  createNavigationShellFrameRendererRegistry as createCoreNavigationShellFrameRendererRegistry,
+  resolveNavigationShellFrameRenderer as resolveCoreNavigationShellFrameRenderer,
+  type NavigationShellFrameRendererBinding as CoreNavigationShellFrameRendererBinding,
+  type NavigationShellFrameRendererRegistry as CoreNavigationShellFrameRendererRegistry,
+} from '@cohesivesystems/presentation-core'
+export {
+  createNavigationShellFrameRendererKey,
+  getNavigationShellFrameRendererRegistryKeys,
+  hasNavigationShellFrameRendererBinding,
+} from '@cohesivesystems/presentation-core'
+
+export interface ProjectedNavigationShellFrameRenderContext<TLayout = unknown> {
+  readonly activePath: string
+  readonly children: ReactNode
+  readonly layout: TLayout
+  readonly navigation: NavigationDefinition
+  readonly renderNodeIcon?: (node: NavigationNodeDefinition) => ReactNode
+  readonly renderShellIcon?: (icon: string) => ReactNode
+  readonly renderShellRegion?: (region: NavigationShellRegionDefinition) => ReactNode
+  readonly renderSlot: (slot: NavigationShellSlotDefinition | null) => ReactNode
+}
+
+export type NavigationShellFrameRenderer<TLayout = unknown> = (
+  context: ProjectedNavigationShellFrameRenderContext<TLayout>,
+) => ReactNode
+
+export type NavigationShellFrameRendererRegistry<TLayout = unknown> =
+  CoreNavigationShellFrameRendererRegistry<NavigationShellFrameRenderer<TLayout>>
+
+export type NavigationShellFrameRendererBinding<TLayout = unknown> =
+  CoreNavigationShellFrameRendererBinding<NavigationShellFrameRenderer<TLayout>>
+
+export function createNavigationShellFrameRendererRegistry<TLayout>(
+  bindings: readonly NavigationShellFrameRendererBinding<TLayout>[],
+): NavigationShellFrameRendererRegistry<TLayout> {
+  return createCoreNavigationShellFrameRendererRegistry(bindings)
+}
+
+export function resolveNavigationShellFrameRenderer<TLayout>(
+  registry: NavigationShellFrameRendererRegistry<TLayout> | null | undefined,
+  kind: NavigationShellKind | string | number,
+) {
+  return resolveCoreNavigationShellFrameRenderer(registry, kind)
+}

package/src/navigation-shell-region-component-registry.tsx

@@ -0,0 +1,127 @@
+import type { ComponentType, ReactNode } from 'react'
+
+import {
+  presentationTargetKinds,
+  type NavigationShellRegionDefinition,
+} from '@cohesivesystems/presentation-contracts'
+import {
+  createPresentationEnumDiscriminator,
+  createNavigationShellRegionComponentRegistry as createCoreNavigationShellRegionComponentRegistry,
+  getNavigationShellRegionComponentRegistryKeys,
+  hasNavigationShellRegionComponentBinding,
+  hasNavigationShellRegionComponentTargetBinding as hasCoreNavigationShellRegionComponentTargetBinding,
+  resolveNavigationShellRegionComponent as resolveCoreNavigationShellRegionComponent,
+  type NavigationShellRegionComponentModuleProjection,
+  type NavigationShellRegionComponentRegistry as CoreNavigationShellRegionComponentRegistry,
+  type NavigationShellRegionComponentResolution as CoreNavigationShellRegionComponentResolution,
+  type ResolveNavigationShellRegionComponentOptions as CoreResolveNavigationShellRegionComponentOptions,
+} from '@cohesivesystems/presentation-core'
+
+export {
+  getNavigationShellRegionComponentRegistryKeys,
+  hasNavigationShellRegionComponentBinding,
+}
+
+export type { NavigationShellRegionComponentModuleProjection }
+
+/**
+ * Props passed to a React component that renders a navigation shell region.
+ */
+export interface NavigationShellRegionComponentProps {
+  /** Navigation shell region definition selected by the shell runtime. */
+  readonly region: NavigationShellRegionDefinition
+}
+
+/**
+ * React component type used to render one navigation shell region.
+ */
+export type NavigationShellRegionComponentRenderer =
+  ComponentType<NavigationShellRegionComponentProps>
+
+/**
+ * React renderer registry for navigation shell regions.
+ */
+export type NavigationShellRegionComponentRegistry =
+  CoreNavigationShellRegionComponentRegistry<NavigationShellRegionComponentRenderer>
+
+/**
+ * React-specific shell region component resolution.
+ */
+export type NavigationShellRegionComponentResolution =
+  CoreNavigationShellRegionComponentResolution<NavigationShellRegionComponentRenderer>
+
+/**
+ * Inputs used to resolve a React navigation shell region renderer.
+ *
+ * The React wrapper supplies the React target discriminator internally.
+ */
+export type ResolveNavigationShellRegionComponentOptions =
+  Omit<
+    CoreResolveNavigationShellRegionComponentOptions<
+      NavigationShellRegionComponentRenderer
+    >,
+    'targetKind'
+  >
+
+/**
+ * Creates a typed React navigation shell region component registry.
+ */
+export function createNavigationShellRegionComponentRegistry(
+  registry: NavigationShellRegionComponentRegistry,
+) {
+  return createCoreNavigationShellRegionComponentRegistry(registry)
+}
+
+/**
+ * Tests whether a React shell region resolves to a renderer through the active
+ * target bindings and registry.
+ */
+export function hasNavigationShellRegionComponentTargetBinding(
+  options: ResolveNavigationShellRegionComponentOptions,
+) {
+  return hasCoreNavigationShellRegionComponentTargetBinding({
+    ...options,
+    targetKind: reactPresentationTargetKind,
+  })
+}
+
+/**
+ * Host component that resolves and renders a projected navigation shell region.
+ */
+export function ProjectedNavigationShellRegionComponentHost({
+  componentSet,
+  fallback = null,
+  module,
+  region,
+  registry,
+}: ResolveNavigationShellRegionComponentOptions & {
+  readonly fallback?: ReactNode
+}) {
+  const resolution = resolveNavigationShellRegionComponent({
+    componentSet,
+    module,
+    region,
+    registry,
+  })
+  const Renderer = resolution.renderer
+
+  return Renderer ? <Renderer region={region} /> : fallback
+}
+
+/**
+ * Resolves the React renderer for a projected navigation shell region.
+ */
+export function resolveNavigationShellRegionComponent(
+  options: ResolveNavigationShellRegionComponentOptions,
+): NavigationShellRegionComponentResolution {
+  return resolveCoreNavigationShellRegionComponent({
+    ...options,
+    targetKind: reactPresentationTargetKind,
+  })
+}
+
+const reactPresentationTargetKind = createPresentationEnumDiscriminator(
+  presentationTargetKinds,
+  'react',
+  'React',
+)

package/src/navigation-shell-slot-renderer-registry.ts

@@ -0,0 +1,88 @@
+import type { ReactNode } from 'react'
+
+import type {
+  NavigationDefinition,
+  NavigationNodeDefinition,
+  NavigationShellRegionDefinition,
+  NavigationShellSlotDefinition,
+  NavigationShellSlotKind,
+} from '@cohesivesystems/presentation-contracts'
+import {
+  createNavigationShellSlotRendererRegistry as createCoreNavigationShellSlotRendererRegistry,
+  resolveNavigationShellSlotRenderer as resolveCoreNavigationShellSlotRenderer,
+  type NavigationShellSlotRendererBinding as CoreNavigationShellSlotRendererBinding,
+  type NavigationShellSlotRendererRegistry as CoreNavigationShellSlotRendererRegistry,
+} from '@cohesivesystems/presentation-core'
+export {
+  createNavigationShellSlotRendererKey,
+  getNavigationShellSlotRendererCandidateKeys,
+  getNavigationShellSlotRendererRegistryKeys,
+  hasNavigationShellSlotRendererBinding,
+  navigationShellSlotAnyPlacement,
+} from '@cohesivesystems/presentation-core'
+
+export interface ProjectedNavigationShellSlotRenderContext<
+  TSlotLayout = unknown,
+  TComponentSystem = unknown,
+> {
+  readonly activePath: string
+  readonly children: ReactNode
+  readonly componentSystem: TComponentSystem
+  readonly navigation: NavigationDefinition
+  readonly renderNodeIcon?: (node: NavigationNodeDefinition) => ReactNode
+  readonly renderShellIcon?: (icon: string) => ReactNode
+  readonly renderShellRegion?: (region: NavigationShellRegionDefinition) => ReactNode
+  readonly slot: NavigationShellSlotDefinition
+  readonly slotLayout: TSlotLayout
+}
+
+export type NavigationShellSlotRenderer<
+  TSlotLayout = unknown,
+  TComponentSystem = unknown,
+> = (
+  context: ProjectedNavigationShellSlotRenderContext<
+    TSlotLayout,
+    TComponentSystem
+  >,
+) => ReactNode
+
+export type NavigationShellSlotRendererRegistry<
+  TSlotLayout = unknown,
+  TComponentSystem = unknown,
+> = CoreNavigationShellSlotRendererRegistry<
+  NavigationShellSlotRenderer<TSlotLayout, TComponentSystem>
+>
+
+export type NavigationShellSlotRendererBinding<
+  TSlotLayout = unknown,
+  TComponentSystem = unknown,
+> = CoreNavigationShellSlotRendererBinding<
+  NavigationShellSlotRenderer<TSlotLayout, TComponentSystem>
+>
+
+export function createNavigationShellSlotRendererRegistry<
+  TSlotLayout,
+  TComponentSystem,
+>(
+  bindings: readonly NavigationShellSlotRendererBinding<
+    TSlotLayout,
+    TComponentSystem
+  >[],
+): NavigationShellSlotRendererRegistry<TSlotLayout, TComponentSystem> {
+  return createCoreNavigationShellSlotRendererRegistry(bindings)
+}
+
+export function resolveNavigationShellSlotRenderer<
+  TSlotLayout,
+  TComponentSystem,
+>(
+  registry: NavigationShellSlotRendererRegistry<
+    TSlotLayout,
+    TComponentSystem
+  > | null | undefined,
+  slot: NavigationShellSlotDefinition,
+) {
+  return resolveCoreNavigationShellSlotRenderer(registry, slot)
+}
+
+export type { NavigationShellSlotKind }