@digi-frontend/dgate-api-documentation 1.2.0 → 1.3.0

package/src/components/JsonInput/JsonInput.tsx

@@ -0,0 +1,149 @@
+import React, { useEffect, useState } from 'react'
+import yaml from 'js-yaml'
+import styles from './style.module.scss'
+import regex from '../../constants/regex'
+
+const errorMapping = {
+  BOTH: 'Invalid JSON or YAML format',
+  JSON: 'Invalid JSON format',
+  YML: 'Invalid YAML format',
+}
+
+const JsonInput = ({
+  placeholder,
+  label,
+  value,
+  onValidation,
+  onChange,
+  dataId,
+  className = '',
+  errorMessage,
+  acceptType = 'BOTH',
+  fieldIsDisabled,
+  withFooter = true,
+}) => {
+  const [isValid, setIsValid] = useState()
+  const [disabledBeautify, setDisabledBeautify] = useState(true)
+
+  const handlePrettify = (e) => {
+    if (value === '') return
+    e.preventDefault()
+    try {
+      let prettifiedData
+      if ((acceptType === 'BOTH' || acceptType === 'JSON') && isValidJson(value)) {
+        // If it's valid JSON, prettify JSON
+        prettifiedData = JSON.stringify(JSON.parse(value), null, 2)
+      } else if (acceptType === 'BOTH' || acceptType === 'YML') {
+        // If it's not valid JSON, prettify YAML
+        prettifiedData = yaml.dump(yaml.load(value), { indent: 0 })
+      }
+      onChange(prettifiedData)
+      setIsValid(true) // Reset validity status
+    } catch (error) {
+      console.error(error)
+      setIsValid(false)
+    }
+  }
+
+  // Function to check if input is valid JSON
+  const isValidJson = (str) => {
+    try {
+      JSON.parse(str)
+      return true
+    } catch (error) {
+      return false
+    }
+  }
+
+  const checkIsValid = () => {
+    if (acceptType === 'BOTH' || acceptType === 'JSON') {
+      return isValidJson(value)
+    } else if (acceptType === 'BOTH' || acceptType === 'YML') {
+      try {
+        // Try parsing as YAML
+        yaml.load(value)
+        return true
+      } catch (error) {
+        console.error(error)
+        return false
+      }
+    }
+  }
+
+  useEffect(() => {
+    try {
+      handlePrettify(value)
+    } catch {}
+  }, [])
+
+  return (
+    <div
+      className={`${styles['json-editor-container']} ${className} ${
+        fieldIsDisabled ? styles.disabled : ''
+      }`}
+    >
+      {label && <p className={`${styles['json-editor-label']}`}>{label}</p>}
+      <div
+        className={`${styles['json-editor']} ${
+          value !== '' && isValid === false ? styles.invalid : ''
+        }`}
+      >
+        <textarea
+          disabled={fieldIsDisabled}
+          data-id={dataId}
+          value={value}
+          onChange={(e) => {
+            if (fieldIsDisabled) return
+            if (regex.ASCII.test(e.target.value)) {
+              setIsValid(undefined)
+              setDisabledBeautify(true)
+              onChange(e.target.value)
+            }
+          }}
+          onPaste={(e) => {
+            if (fieldIsDisabled) return
+            if (regex.ASCII.test(e.target.value)) {
+              setIsValid(undefined)
+              setDisabledBeautify(true)
+              onChange(e.target.value)
+            }
+          }}
+          min="1"
+          placeholder={placeholder}
+        />
+        {withFooter && (
+          <div className={`${styles['actions-container']}`}>
+            <button
+              type="button"
+              className={styles.validate}
+              onClick={() => {
+                const valid = checkIsValid()
+                setIsValid(valid)
+                onValidation(valid)
+                setDisabledBeautify(!checkIsValid())
+              }}
+              data-id={`${dataId}-VALIDATE-BUTTON`}
+              disabled={value === ''}
+            >
+              Validate
+            </button>
+            <button
+              type="button"
+              disabled={value === '' || disabledBeautify}
+              data-id={`${dataId}-BEAUTIFY-BUTTON`}
+              className={styles.beautify}
+              onClick={handlePrettify}
+            >
+              Beautify
+            </button>
+          </div>
+        )}
+      </div>
+      {(errorMessage || (value !== '' && isValid === false)) && (
+        <p className={styles['error-message']}>{errorMessage || errorMapping[acceptType]}</p>
+      )}
+    </div>
+  )
+}
+
+export default JsonInput

package/src/components/LivePreview/LivePreview.tsx

@@ -0,0 +1,224 @@
+import React, { useEffect, useState } from 'react'
+import styles from './LivePreview.module.scss'
+import SimpleLabelValue from '../../components/SimpleLabelValue'
+import MethodsAccordion from '../../components/MethodAccordion/MethodAccordion'
+import { TransformedOpenApi } from '../../types/transformedOpenApi'
+import { useFormikContext } from 'formik'
+import { methodColorMapping, tagsTableHeaders } from '../../constants/index'
+import TagsTable from '../table/tags-table'
+import { Accordion, Button, Chip } from 'digitinary-ui'
+import Tooltip from '../../components/Tooltip/Tooltip'
+import SVGLoader from '../../components/SVGLoader/SVGLoader'
+import { DownArrowIcon } from '../../assets/icons'
+
+interface LivePreviewProps {
+  transformedData?: TransformedOpenApi
+  openApiErrors?: any[]
+}
+
+const LivePreview: React.FC<LivePreviewProps> = ({ transformedData, openApiErrors }) => {
+  const [tableRecords, setTableRecords] = useState()
+  const [tooltipRefs, setTooltipRefs] = useState<{ [key: number]: any }>({})
+  const [tableData, setTableData] = useState([])
+  const [externalTooltipRefs, setExternalTooltipRefs] = useState<{ [key: number]: any }>({})
+  const [errorExpanded, setErrorExpanded] = useState(openApiErrors.length > 0)
+  const { values } = useFormikContext<TransformedOpenApi>()
+  const { info, components, tags } = values
+  const { securitySchemes } = components
+  const securityKey =
+    securitySchemes && typeof securitySchemes == 'object' && Object.keys(securitySchemes).length
+      ? Object.keys(securitySchemes)[0]
+      : null
+
+  useEffect(() => {
+    if (values.tags) {
+      setTableRecords(generateTableData(values.tags, true))
+      setTableData(values.tags)
+    }
+  }, [values.tags])
+
+  const generateTableData = (items, readOnly) => {
+    return items.map((item, index) => ({
+      id: index,
+      tagName: item.name,
+      description: (
+        <Tooltip
+          key={`${index}-description`}
+          allowHTML
+          disabled={item.description?.length <= 12}
+          content={<div style={{ padding: '0.625rem' }}>{item.description}</div>}
+          arrowWithBorder
+          placement="bottom-end"
+          type="function"
+          delay={[0, 0]}
+        >
+          <div className={styles.paramDescContainer}>
+            <p className={styles.editDescBtn}>
+              {item.description ? item.description.substring(0, 12) : '-'}
+              {item.description && item.description.length > 12 ? '...' : ''}
+            </p>
+          </div>
+        </Tooltip>
+      ),
+      externalDocs: (
+        <div className={styles.paramDescContainer}>
+          {item.externalDocs && item.externalDocs.url && item.externalDocs.url != '-' ? (
+            <a
+              className={styles.editDescBtn}
+              href={
+                item.externalDocs?.url && item.externalDocs?.url.indexOf('http') > -1
+                  ? item.externalDocs?.url
+                  : `https://${item.externalDocs?.url}`
+              }
+              rel="noopener noreferrer"
+              target="_blank"
+            >
+              {item?.externalDocs?.url && !item?.externalDocs?.description
+                ? item?.externalDocs?.url
+                : null}
+              {item?.externalDocs?.description
+                ? item?.externalDocs?.description?.substring(0, 12)
+                : !item?.externalDocs?.url
+                ? '-'
+                : null}
+              {item?.externalDocs?.description && item?.externalDocs?.description?.length > 12
+                ? '...'
+                : ''}
+            </a>
+          ) : (
+            <Button className={styles.editDescBtn} variant="link" color="action">
+              {item.externalDocs?.description
+                ? item.externalDocs?.description.substring(0, 12)
+                : '-'}
+              {item.externalDocs?.description && item.externalDocs?.description.length > 12
+                ? '...'
+                : ''}
+            </Button>
+          )}
+
+          {/* </Tooltip> */}
+
+          {!readOnly && <div className={styles.paramDescContainer_separator}></div>}
+
+          {!readOnly && (
+            <Button
+              className={styles.deleteParamBtn}
+              variant="link"
+              color="error"
+              onClick={() => null}
+            ></Button>
+          )}
+        </div>
+      ),
+    }))
+  }
+
+  const securityScheme = !!securityKey
+    ? securitySchemes[securityKey].scheme || securitySchemes[securityKey].type
+    : '-'
+
+  return (
+    <div className={styles.livePreviewContainer}>
+      {!!openApiErrors && openApiErrors.length > 0 && (
+        <div className="row">
+          <div className="col-md-12">
+            <Accordion
+              expanded={errorExpanded}
+              onChange={() => null}
+              className={styles.responseAccordion}
+              summary={
+                <span
+                  className={styles.responseAccordionSummary}
+                  onClick={() => setErrorExpanded((prev) => !errorExpanded)}
+                >
+                  <div className={styles.responseAccordionSummary_title}>Errors</div>
+                  <SVGLoader
+                    className={errorExpanded ? styles.expanded : ''}
+                    src={DownArrowIcon}
+                    width="2rem"
+                    height="2rem"
+                  />
+                </span>
+              }
+              children={
+                <div className={styles.accordionContent}>
+                  <span>
+                    Failed to update the OpenAPI documentation. Please resolve the following issues:
+                  </span>
+                  <br />
+                  <ol>
+                    {openApiErrors.map((errItem) => (
+                      <li key={errItem}>{errItem}</li>
+                    ))}
+                  </ol>
+                </div>
+              }
+            />
+          </div>
+        </div>
+      )}
+      <div className="row">
+        <div className="col-md-12">
+          <div className={styles.titleContainer}>
+            <p className={styles.apiName}>{info?.title?.trim() || '-'}</p>
+            <Chip className={styles.livePreviewChip}>Live Preview</Chip>
+          </div>
+          <SimpleLabelValue key={'version'} label={'Version: '} value={info?.version || '-'} />
+          <SimpleLabelValue
+            key={'description'}
+            label={'Description: '}
+            className={styles.description_preview}
+            value={info?.description?.trim() || '-'}
+          />
+
+          <SimpleLabelValue key={'tags'} label={'Tags: '} />
+          <TagsTable
+            id="tags-table"
+            data={tableRecords}
+            headCells={tagsTableHeaders}
+            isFormOpen={false}
+            setIsFormOpen={() => null}
+            saveNewRow={() => null}
+            readOnly={true}
+          />
+
+          <SimpleLabelValue key={'endpoints'} label={'Endpoints '} />
+          {Object.entries(
+            values.paths
+              .flatMap((path) =>
+                path.methods.map((method) => ({
+                  ...method,
+                  path: path.path,
+                  tags: method.tags?.length ? method.tags : ['default'],
+                }))
+              )
+              .reduce((acc, method) => {
+                method.tags.forEach((tag) => {
+                  if (!acc[tag]) acc[tag] = []
+                  acc[tag].push(method)
+                })
+                return acc
+              }, {} as Record<string, any[]>)
+          ).map(([tag, methods]) => (
+            <div className={styles.methodsContainer} key={tag}>
+              <h3>{tag}</h3>
+              {methods
+                .sort((a, b) => methodColorMapping[a.type].order - methodColorMapping[b.type].order)
+                .map((method) => (
+                  <MethodsAccordion
+                    key={`${method.path}_${method.type}`}
+                    readOnly
+                    method={method}
+                    path={method.path}
+                    tags={values.tags}
+                  />
+                ))}
+            </div>
+          ))}
+        </div>
+      </div>
+    </div>
+  )
+}
+
+export default LivePreview