feat(plugins/plugin-client-common): allow wizard steps to be specified in topmatter

Author: starpit

plugins/plugin-client-common/src/components/Content/Markdown/KuiFrontmatter.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2022 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface WizardSteps {
+  /** An alternate way to define the steps of a wizard layout */
+  wizard: {
+    steps: string[]
+  }
+}
+
+type KuiFrontmatter = Partial<WizardSteps> & {
+  /** Title of the Notebook */
+  title?: string
+
+  layoutCount?: Record<string, number>
+
+  /**
+   * A mapping that indicates which section (the `number` values) should be rendered in a given split position.
+   */
+  layout?: 'wizard' | Record<number | 'default', SplitPositionSpec>
+}
+
+export function hasWizardSteps(frontmatter: KuiFrontmatter): frontmatter is KuiFrontmatter & Required<WizardSteps> {
+  return (
+    frontmatter.wizard &&
+    frontmatter.wizard.steps &&
+    Array.isArray(frontmatter.wizard.steps) &&
+    frontmatter.wizard.steps.length > 0
+  )
+}
+
+type SplitPosition = 'left' | 'bottom' | 'default' | 'wizard'
+type SplitPositionObj = { position: SplitPosition; placeholder?: string; maximized?: boolean | 'true' | 'false' }
+type SplitPositionSpec = SplitPosition | SplitPositionObj
+
+export type PositionProps = {
+  'data-kui-split': SplitPosition
+}
+
+export function isValidPosition(position: SplitPositionSpec): position is SplitPosition {
+  return (
+    typeof position === 'string' &&
+    (position === 'default' || position === 'left' || position === 'bottom' || position === 'wizard')
+  )
+}
+
+export function isValidPositionObj(position: SplitPositionSpec): position is SplitPositionObj {
+  const pos = position as SplitPositionObj
+  return typeof pos === 'object' && typeof pos.position === 'string'
+}
+
+export default KuiFrontmatter

plugins/plugin-client-common/src/components/Content/Markdown/codeblocks/encoding.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2022 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { isCodedError, isWatchable } from '@kui-shell/core'
+import { CodeBlockResponse } from '../components/code'
+
+function stringifyError(response: Error) {
+  return { code: isCodedError(response) ? response.code : 1, message: response.message }
+}
+
+/** Blunt attempt to avoid serializing React bits */
+function reactRedactor(key: string, value: any) {
+  if (key === 'tab') {
+    return undefined
+  } else if (key === 'block') {
+    return undefined
+  } else if (value && typeof value === 'object' && value.constructor === Error) {
+    // the first check guards against typeof null === 'object'
+    return stringifyError(value)
+  } else {
+    return value
+  }
+}
+
+export default function encodePriorResponses(responses: CodeBlockResponse[]): string {
+  return JSON.stringify(
+    responses.map(response => {
+      if (response.response.constructor === Error) {
+        return Object.assign({}, response, { response: stringifyError(response.response) })
+      } else if (isWatchable(response.response)) {
+        delete response.response.watch
+      }
+      return response
+    }),
+    reactRedactor
+  )
+}

plugins/plugin-client-common/src/components/Content/Markdown/components/Wizard/rehype-wizard.ts

@@ -17,7 +17,7 @@
 import { u } from 'unist-builder'
 import { visitParents } from 'unist-util-visit-parents'
 
-import { PositionProps } from '../../frontmatter'
+import { PositionProps } from '../../KuiFrontmatter'
 
 interface Primordial {
   title: string

plugins/plugin-client-common/src/components/Content/Markdown/components/div.tsx

@@ -20,7 +20,7 @@ import { TextContent } from '@patternfly/react-core'
 import SplitInjector from '../../../Views/Terminal/SplitInjector'
 import SplitPosition from '../../../Views/Terminal/SplitPosition'
 
-import { PositionProps } from '../frontmatter'
+import { PositionProps } from '../KuiFrontmatter'
 
 import { isWizard } from './Wizard/rehype-wizard'
 const Wizard = React.lazy(() => import('./Wizard'))