chore: bump to the latest madwizard

also update bin/codeflare to use cli mode as the default, with `-u` as the popup option

Author: starpit

bin/codeflare

@@ -111,12 +111,13 @@ else
     export GUIDEBOOK_STORE=git
 fi
 
-# check if the user wants us to run the headless version (currently
-# indicated by the -c option)
-while getopts "c" opt
+# check if the user wants us to run the graphical version (currently
+# indicated by the -u option)
+do_cli=1
+while getopts "u" opt
 do
     case $opt in
-    (c) do_cli=1; shift; continue;;
+    (u) do_cli=0; shift; continue;;
     esac
 done
 

package-lock.json

@@ -77,10 +77,10 @@
     "printWidth": 120
   },
   "devDependencies": {
-    "@kui-shell/builder": "11.5.0-dev-20220525-112639",
-    "@kui-shell/proxy": "11.5.0-dev-20220525-112639",
-    "@kui-shell/react": "11.5.0-dev-20220525-112639",
-    "@kui-shell/webpack": "11.5.0-dev-20220525-112639",
+    "@kui-shell/builder": "11.5.0-dev-20220525-173538",
+    "@kui-shell/proxy": "11.5.0-dev-20220525-173538",
+    "@kui-shell/react": "11.5.0-dev-20220525-173538",
+    "@kui-shell/webpack": "11.5.0-dev-20220525-173538",
     "@playwright/test": "^1.22.2",
     "@types/debug": "^4.1.7",
     "@types/node": "14.11.8",
@@ -100,18 +100,18 @@
   },
   "dependencies": {
     "@kui-shell/client": "file:./plugins/plugin-client-default",
-    "@kui-shell/core": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-bash-like": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-carbon-themes": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-client-common": "11.5.0-dev-20220525-112639",
+    "@kui-shell/core": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-bash-like": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-carbon-themes": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-client-common": "11.5.0-dev-20220525-173538",
     "@kui-shell/plugin-codeflare": "file:./plugins/plugin-codeflare",
-    "@kui-shell/plugin-core-support": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-electron-components": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-git": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-kubectl": "11.5.0-dev-20220525-112639",
+    "@kui-shell/plugin-core-support": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-electron-components": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-git": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-kubectl": "11.5.0-dev-20220525-173538",
     "@kui-shell/plugin-madwizard": "file:./plugins/plugin-madwizard",
-    "@kui-shell/plugin-patternfly4-themes": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-proxy-support": "11.5.0-dev-20220525-112639",
-    "@kui-shell/plugin-s3": "11.5.0-dev-20220525-112639"
+    "@kui-shell/plugin-patternfly4-themes": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-proxy-support": "11.5.0-dev-20220525-173538",
+    "@kui-shell/plugin-s3": "11.5.0-dev-20220525-173538"
   }
 }

package.json

@@ -23,6 +23,6 @@
     "access": "public"
   },
   "dependencies": {
-    "madwizard": "^0.7.27"
+    "madwizard": "^0.8.1"
   }
 }

plugins/plugin-madwizard/package.json

@@ -20,28 +20,7 @@ import { i18n, Tab } from "@kui-shell/core"
 import { Card, CardResponse, Icons, Loading, Markdown } from "@kui-shell/plugin-client-common"
 import { ButtonProps, Chip, ChipGroup, Grid, GridItem, Progress, Tile, WizardStep } from "@patternfly/react-core"
 
-import {
-  Choice,
-  Choices,
-  CodeBlockProps,
-  Status,
-  Title,
-  Description,
-  OrderedGraph,
-  extractTitle,
-  extractDescription,
-  sameGraph,
-  order,
-  compile,
-  validate,
-  findChoiceFrontier,
-  wizardify,
-  Wizard as WizardModel,
-  ChoiceStep,
-  isChoiceStep,
-  TaskStep,
-  isTaskStep,
-} from "madwizard"
+import { Graph, CodeBlock, Choices, Wizard as Wiz } from "madwizard"
 
 import read from "../read"
 import Wizard from "./Wizard/KWizard"
@@ -51,37 +30,37 @@ import "@kui-shell/plugin-client-common/web/scss/components/Wizard/Guide.scss"
 
 const strings = i18n("plugin-client-common", "code")
 
-export type Props = Choices &
-  Partial<Title> &
-  Partial<Description> & {
+export type Props = Choices.Choices &
+  Partial<CodeBlock.Title> &
+  Partial<CodeBlock.Description> & {
     /** Enclosing Kui Tab */
     tab: Tab
 
     /** markdown document id */
     uuid: string
 
     /** Raw list of code blocks */
-    blocks: CodeBlockProps[]
+    blocks: CodeBlock.CodeBlockProps[]
 
     /** Status of code blocks */
     // codeBlockResponses: CodeBlockResponseFn
   }
 
-type State = Choices & {
+type State = Choices.Choices & {
   /** Internal error in rendering? */
   error?: unknown
 
   /** Graph of code blocks to be executed */
-  graph: OrderedGraph
+  graph: Graph.OrderedGraph
 
   /** Choice Frontier */
-  frontier: ReturnType<typeof findChoiceFrontier>
+  frontier: ReturnType<typeof Graph.findChoiceFrontier>
 
   /** Instance of Wizard model */
-  wizard: WizardModel
+  wizard: Wiz.Wizard
 
   /** validation status of each wizard step */
-  wizardStepStatus: Status[]
+  wizardStepStatus: Graph.Status[]
 
   /** Which of `wizardStepStatus` to display (indexed from 1) */
   startAtStep: number
@@ -102,23 +81,23 @@ export default class Guide extends React.PureComponent<Props, State> {
   /**
    * TODO move to a more common location?
    */
-  private static isValidFrontier(frontier: ReturnType<typeof findChoiceFrontier>): boolean {
+  private static isValidFrontier(frontier: ReturnType<typeof Graph.findChoiceFrontier>): boolean {
     return frontier.length > 0 && frontier.every((_) => (_.prereqs && _.prereqs.length > 0) || !!_.choice)
   }
 
   private async init(props: Props, useTheseChoices?: State["choices"]) {
     const choices = useTheseChoices || props.choices
-    const newGraph = await compile(props.blocks, choices, undefined, "sequence", props.title, props.description)
+    const newGraph = await Graph.compile(props.blocks, choices, undefined, "sequence", props.title, props.description)
     choices.onChoice(this.onChoiceFromAbove)
 
     this.setState((state) => {
-      const noChangeToGraph = state && sameGraph(state.graph, newGraph)
+      const noChangeToGraph = state && Graph.sameGraph(state.graph, newGraph)
 
-      const graph = noChangeToGraph ? state.graph : order(newGraph)
-      const frontier = noChangeToGraph && state && state.frontier ? state.frontier : findChoiceFrontier(graph)
+      const graph = noChangeToGraph ? state.graph : Graph.order(newGraph)
+      const frontier = noChangeToGraph && state && state.frontier ? state.frontier : Graph.findChoiceFrontier(graph)
 
       const startAtStep = state ? state.startAtStep : 1
-      const wizard = wizardify(graph, { previous: state ? state.wizard : undefined })
+      const wizard = Wiz.wizardify(graph, { previous: state ? state.wizard : undefined })
       const wizardStepStatus = noChangeToGraph && state ? state.wizardStepStatus : []
 
       const isRunning = state ? state.isRunning : false
@@ -144,7 +123,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   /** @return a UI component to visualize the given markdown source */
-  private renderContent(source: TaskStep["step"]["content"]) {
+  private renderContent(source: Wiz.TaskStep["step"]["content"]) {
     return (
       source &&
       this.stepContent(
@@ -165,7 +144,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   /** A choice was made somewhere in the UI */
-  private readonly onChoiceFromAbove = ({ choices }: Choices) => this.init(this.props, choices.clone())
+  private readonly onChoiceFromAbove = ({ choices }: Choices.Choices) => this.init(this.props, choices.clone())
 
   /**
    * A choice was made in *this* UI. The `this.props.choices.set()`
@@ -181,7 +160,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   /** @return UI that offers the user a choice */
-  private tilesForChoice(choice: Choice) {
+  private tilesForChoice(choice: Graph.Choice) {
     return this.stepContent(
       <Grid hasGutter span={4}>
         {choice.choices.map((_) => {
@@ -206,7 +185,7 @@ export default class Guide extends React.PureComponent<Props, State> {
     )
   }
 
-  private withStatus(name: WizardStep["name"], status: Status) {
+  private withStatus(name: WizardStep["name"], status: Graph.Status) {
     const icon = status && statusToIcon(status)
     if (icon) {
       return (
@@ -231,7 +210,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   /** Add React `component` to the given choice step */
-  private choiceUI({ status, step, graph }: ChoiceStep, isFirstChoice: boolean) {
+  private choiceUI({ status, step, graph }: Wiz.ChoiceStep, isFirstChoice: boolean) {
     return {
       status,
       graph,
@@ -250,15 +229,15 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   /** Add React `component` to the given task execution step */
-  private taskUI({ status, step, graph }: TaskStep) {
+  private taskUI({ status, step, graph }: Wiz.TaskStep) {
     return {
       status,
       graph,
       step: {
         name: step.name === "Missing title" ? <span className="red-text">{step.name}</span> : step.name,
         component: this.renderContent(step.content),
         stepNavItemProps: {
-          children: this.wizardStepDescription(extractDescription(graph)),
+          children: this.wizardStepDescription(Graph.extractDescription(graph)),
         },
       },
     }
@@ -268,13 +247,13 @@ export default class Guide extends React.PureComponent<Props, State> {
   private wizardSteps() {
     let isFirstChoice = true
     return this.state.wizard.reduce((uiSteps, _, idx, A) => {
-      if (isChoiceStep(_)) {
+      if (Wiz.isChoiceStep(_)) {
         const ui = this.choiceUI(_, isFirstChoice)
         isFirstChoice = false
         uiSteps.push(ui)
-      } else if (isTaskStep(_)) {
+      } else if (Wiz.isTaskStep(_)) {
         const previous = A[idx - 1]
-        if (!previous || !isTaskStep(previous) || previous.step.name !== _.step.name) {
+        if (!previous || !Wiz.isTaskStep(previous) || previous.step.name !== _.step.name) {
           // task steps with multiple code blocks... combine them into one ui step
           uiSteps.push(this.taskUI(_))
         }
@@ -287,7 +266,9 @@ export default class Guide extends React.PureComponent<Props, State> {
     Promise.all(
       steps.map(async (_, idx) => {
         if (!this.state.wizardStepStatus[idx] || this.state.wizardStepStatus[idx] === "blank") {
-          const status = await validate(_.graph, { validator: (cmdline: string) => this.props.tab.REPL.qexec(cmdline) })
+          const status = await Graph.validate(_.graph, {
+            validator: (cmdline: string) => this.props.tab.REPL.qexec(cmdline),
+          })
           if (status !== this.state.wizardStepStatus[idx]) {
             this.setState((curState) => ({
               wizardStepStatus: [
@@ -368,7 +349,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   private wizardDescription() {
-    const descriptionContent = extractDescription(this.state.graph)
+    const descriptionContent = Graph.extractDescription(this.state.graph)
     return descriptionContent && <Markdown nested source={descriptionContent} />
   }
 
@@ -377,7 +358,7 @@ export default class Guide extends React.PureComponent<Props, State> {
   }
 
   private wizardTitle() {
-    return extractTitle(this.state.graph)
+    return Graph.extractTitle(this.state.graph)
     // {this.state.isRunning && <span className="small-left-pad">{statusToIcon('in-progress')}</span>}
   }