LogicBuilder.App.Spa.Utils 1.0.1

LogicBuilder.App.Spa.Utils

LogicBuilder.App.Spa.Utils consolidates the methods and class designs used by an API that hosts a UI workflow generated by BPS Logic Builder, supporting a single page application (SPA).

The library centralizes the server-side logic that drives a Logic Builder-generated flow: managing flow state, routing requests to the correct handler, and producing the screen settings that the SPA client renders at each step.

Key Components

• FlowManager (IFlowManager) The central orchestrator for a flow session. It coordinates the DirectorBase (from LogicBuilder.RulesDirector), the flow's data cache, rules cache, and progress tracking. It exposes the main entry points consumed by the hosting API:

  • Start / NavStart — begin a flow at a given module/stage, seeding persistent flow items from the navigation bar request.
  • Next — advance the flow in response to a client RequestBase, dispatching to the appropriate dialog handler and executing the rules engine.
  • RunFlow — run a named flow directly.
  • FlowComplete — mark the flow as finished and return a completion screen.
  • Terminate / SetCurrentBusinessBackupData — lifecycle hooks for ending or checkpointing a flow.

  Each operation returns a FlowSettings object (flow state, navigation bar, and screen settings) that the SPA uses to render the next view, with unhandled exceptions converted into an ExceptionView screen instead of propagating to the client.

• Dialogs (IDialogHandler / BaseDialogHandler) A handler-per-view-type pattern. BaseDialogHandler.Create uses the incoming request's ViewType (e.g., Grid, Detail) to dynamically resolve and instantiate the matching *DialogHandler class (falling back to DefaultDialogHandler). Each handler's Complete method applies the client's request (flow state, selected command button) to the current Director before the rules engine runs.

• Factories (IFlowFactory / FlowFactory) Supplies the DirectorBase and IFlowActivity instances used by a FlowManager, decoupling flow construction from dependency injection so different flow/rules configurations can be wired in per module.

Purpose

Together these classes provide a reusable, host-agnostic engine for:

1. Receiving SPA client requests (navigation, form submission, command button actions).
2. Advancing a BPS Logic Builder–defined flow via the rules engine/director.
3. Producing consistent screen settings/view data for the SPA to render next.

This allows any API hosting a Logic Builder–generated UI workflow to reuse the same flow control, dialog handling, and error-to-view translation logic rather than reimplementing it per project.