@digi-frontend/dgate-api-documentation 1.0.0 → 1.0.4

package/src/components/LivePreview/LivePreview.tsx

@@ -0,0 +1,80 @@
+import React from 'react'
+import styles from './LivePreview.module.scss'
+import SimpleLabelValue from '../../components/SimpleLabelValue'
+import Chips from '../../components/Chips/Chips'
+import MethodsAccordion from '../../components/MethodAccordion/MethodAccordion'
+import { TransformedOpenApi } from '../../types/transformedOpenApi'
+import { useFormikContext } from 'formik'
+
+interface LivePreviewProps {
+  transformedData?: TransformedOpenApi
+}
+
+const LivePreview: React.FC<LivePreviewProps> = ({ transformedData }) => {
+  const { values, setFieldValue } = useFormikContext<TransformedOpenApi>()
+  const { info, components, tags, paths } = values
+  const { securitySchemes } = components
+  const securityKey =
+    securitySchemes && typeof securitySchemes == 'object' && Object.keys(securitySchemes).length
+      ? Object.keys(securitySchemes)[0]
+      : null
+  return (
+    <div>
+      <div className="row">
+        <div className="col-md-12">
+          <p className={styles.apiName}>{info?.title}</p>
+          <SimpleLabelValue
+            key={'APIAuthenticationType'}
+            label={'API authentication type: '}
+            value={!!securityKey ? securitySchemes[securityKey].scheme : '-'}
+          />
+          <SimpleLabelValue key={'version'} label={'Version: '} value={info?.version || '-'} />
+          <SimpleLabelValue
+            key={'description'}
+            label={'Description: '}
+            value={info?.description || '-'}
+          />
+
+          <SimpleLabelValue
+            key={'tags'}
+            label={'Tags: '}
+            value={
+              tags && tags.length ? (
+                <Chips
+                  className={styles.tagsChips}
+                  items={tags.map((t) => ({
+                    id: t.name,
+                    label: t.name,
+                    disabled: true,
+                  }))}
+                />
+              ) : (
+                '-'
+              )
+            }
+          />
+
+          <SimpleLabelValue key={'endpoints'} label={'Endpoints '} />
+          {values.paths.map((path, pathIndex) => (
+            <>
+              {path.methods.map((method, methodIndex) => (
+                <MethodsAccordion
+                  readOnly
+                  method={method}
+                  path={path.path}
+                  setFieldValue={(key, value) => {
+                    const h = `paths[${pathIndex}].methods[${methodIndex}].${key}`
+                    setFieldValue(h, value)
+                  }}
+                  handleSave={()=>null}
+                />
+              ))}
+            </>
+          ))}
+        </div>
+      </div>
+    </div>
+  )
+}
+
+export default LivePreview

package/src/components/MethodAccordion/MethodAccordion.module.scss

@@ -1,182 +1,289 @@
-.methodAccordionContainer {
-  display: flex;
-  flex-direction: column;
-  gap: 1.25rem;
-  padding: 1.25rem 1.875rem;
+.methodAccordion {
+  border: none !important;
+  box-shadow: none !important;
+  margin-bottom: 0 !important;
 
-  .methodAccordion {
-    border: none !important;
-    box-shadow: none;
-    margin-bottom: 0;
+  :global(.summary) {
+    padding: 0 !important;
+    margin: 1.25rem 1.875rem 0 1.875rem !important;
+    height: 2.625rem;
+  }
 
-    :global(.summary) {
-      padding: 0 !important;
-    }
+  :global(.iconContainer .dropdownIcon) {
+    display: none !important;
+  }
 
-    :global(.details) {
-      border: none;
-      padding: 0;
-    }
+  :global(.details.show) {
+    border: none !important;
+    padding: 0 !important;
+  }
 
-    :global(.summary .iconContainer .dropdownIcon) {
-      display: none !important;
-    }
+  .methodSummaryContainer {
+    display: flex;
+    align-items: center;
+    gap: 0.9375rem;
+    margin-bottom: 1.25rem;
 
-    .methodSummaryContainer {
+    .methodSummary {
       display: flex;
-      align-items: center;
-      gap: 0.9375rem;
-      margin-bottom: 1.25rem;
-
-      .methodSummary {
-        display: flex;
-        gap: 0.3125rem;
-        background-color: #f8f9fb;
-        width: 100%;
-        padding: 0.3125rem;
-        border-radius: 0.3125rem;
-
-        .methodLabel {
-          display: grid;
-          place-content: center;
-          width: 5rem;
-          height: 2rem;
-          color: white;
-          border-radius: 0.1875rem;
-        }
-      }
+      gap: 0.3125rem;
+      background-color: #f8f9fb;
+      width: 100%;
+      padding: 0.3125rem;
+      border-radius: 0.3125rem;
 
-      .methodExpandArrowContainer {
+      .methodLabel {
         display: grid;
         place-content: center;
-        width: 2.25rem;
-        aspect-ratio: 1 / 1;
-        border-radius: 100%;
-        background-color: #f8f9fb;
-        margin-left: auto;
-
-        svg {
-          transition: rotate 0.3s ease-in-out;
-        }
+        width: 5rem;
+        height: 2rem;
+        color: white;
+        border-radius: 0.1875rem;
+        text-transform: capitalize;
       }
     }
 
-    &.expanded {
-      .methodExpandArrowContainer {
+    .methodExpandArrowContainer {
+      display: grid;
+      place-content: center;
+      width: 2.25rem;
+      aspect-ratio: 1 / 1;
+      border-radius: 100%;
+      background-color: #f8f9fb;
+      margin-left: auto;
+
+      &.expanded {
         svg {
           rotate: 180deg;
         }
       }
+
+      svg {
+        transition: rotate 0.3s ease-in-out;
+      }
     }
   }
 
-  .paramsTable {
-    .paramDescContainer {
-      display: flex;
+  .methodAccordionContent {
+    display: flex;
+    flex-direction: column;
+    gap: 1.25rem;
+    padding-inline: 1.875rem;
 
-      .paramDescContainer_separator {
-        height: inherit;
-        width: 1px;
-        background-color: #d8dae5;
-      }
+    .divTest {
+      background-color: red;
+      height: 40px;
+      width: 15px;
+    }
 
-      button {
-        svg {
-          path {
-            stroke-width: 0.2;
-          }
+    .divTest:focus {
+      background-color: black;
+    }
+
+    .methodDesc {
+      margin-top: 1.25rem;
+    }
+
+    .paramsTable {
+      .paramDescContainer {
+        display: flex;
+
+        .paramDescContainer_separator {
+          height: inherit;
+          width: 1px;
+          background-color: #d8dae5;
         }
 
-        .editDescBtn {
-          padding: 0;
-          margin-right: 1.25rem;
+        :global(.customBtn) {
+          svg {
+            path {
+              stroke-width: 0.1;
+            }
+          }
 
-          .btnContentWrapper {
-            display: flex;
-            align-items: center;
+          &.editDescBtn {
             padding: 0;
-            color: #12131a;
+            margin-right: 1.25rem;
 
-            .endBtnIcon {
-              margin-block: auto;
+            :global(.btnContentWrapper) {
+              display: flex;
+              align-items: center;
+              padding: 0;
+              color: #12131a;
 
-              svg {
-                path {
-                  fill: #12131a;
+              :global(.endBtnIcon) {
+                margin-block: auto;
+
+                svg {
+                  path {
+                    fill: #12131a;
+                  }
                 }
               }
             }
           }
-        }
 
-        &.deleteParamBtn {
-          padding: 0;
+          &.deleteParamBtn {
+            padding: 0;
 
-          .btnContentWrapper {
-            .endBtnIcon {
-              margin-block: auto;
+            :global(.btnContentWrapper) {
+              :global(.endBtnIcon) {
+                margin-block: auto;
 
-              svg {
-                width: 1.125rem;
+                svg {
+                  width: 1.125rem;
+                }
               }
             }
           }
         }
       }
-    }
 
-    .requiredParam {
-      .headContainer {
-        &::after {
-          content: '*';
-          color: red;
-          transform: translateX(0.125rem);
+      .editDescTooltipContent {
+        display: flex;
+        flex-direction: column;
+        gap: 0.625rem;
+        padding-bottom: 0.625rem;
+
+        > *:not(.editDescTooltipContent_header) {
+          margin-inline: 0.625rem;
+        }
+
+        .editDescTooltipContent_header {
+          font-weight: 600;
+          font-size: 0.875rem;
+          line-height: 1.25rem;
+          padding: 0.75rem 1.25rem;
+          border-bottom: 1px solid #d8dae5;
         }
       }
-    }
-  }
 
-  .requestAccordion,
-  .responseAccordion {
-    border-top: 1px solid #babdcc;
-    border-radius: 0.3125rem !important;
-    box-shadow: none !important;
-    margin-bottom: 0 !important;
-
-    .requestAccordionSummary,
-    .responseAccordionSummary {
-      font-weight: 700;
-      font-size: 1.125rem;
-      line-height: 1.5rem;
+      :global(.requiredParam) {
+        :global(.headContainer) {
+          &::after {
+            content: '*';
+            color: red;
+            transform: translateX(0.125rem);
+          }
+        }
+      }
     }
 
-    :global(.details) {
-      :global(.textArea .inputField) {
-        padding: 0;
-        border: none;
+    .requestAccordion,
+    .responseAccordion {
+      border-top: 1px solid #babdcc;
+      border-radius: 0.3125rem !important;
+      box-shadow: none !important;
+      margin-bottom: 0 !important;
+      cursor: default !important;
+
+      :global(.summary) {
+        margin: 0 !important;
+        padding: 1rem !important;
+        height: auto !important;
       }
-    }
-  }
 
-  .responseAccordion {
-    .responseAccordionSummary {
-      display: flex;
-      align-items: center;
+      :global(.details.show) {
+        border-top: 1px solid #babdcc !important;
+        padding: 1.25rem !important;
+        padding: 0 !important;
+      }
+
+      :global(.details.show .textArea .containerTextArea) {
+        display: flex;
+      }
+
+      :global(.details.show .textArea .containerTextArea .inputField) {
+        height: 100%;
+        padding: 1.25rem;
+      }
 
-      :global(.multiSelectGroup) {
-        width: 6.25rem;
-        height: 2.0625rem !important;
-        min-height: 2.0625rem !important;
-        margin-left: auto;
+      .requestAccordionSummary,
+      .responseAccordionSummary {
+        font-weight: 700;
+        font-size: 1.125rem;
+        line-height: 1.5rem;
+        display: flex;
+        align-items: center;
+        cursor: default !important;
+      }
+
+      .responseAccordionSummary_title,
+      .requestAccordionSummary_title {
+        display: flex;
+        align-items: center;
+        cursor: pointer;
+
+        svg {
+          transition: rotate 0.2s ease-in-out;
+        }
+
+        .expanded {
+          rotate: 180deg;
+        }
+      }
 
-        :global(.selectDisplay) {
+      :global(.details) {
+        :global(.textArea .inputField) {
           padding: 0;
+          border: none;
+        }
+      }
+
+      :global(.summary .iconContainer .dropdownIcon) {
+        display: none !important;
+      }
+
+      :global(.summary) {
+        cursor: default;
+      }
+    }
+
+    .responseAccordion {
+      .responseAccordionSummary {
+        display: flex;
+        align-items: center;
+
+        :global(.multiSelectGroup .optionsList) {
+          width: 8rem !important;
+          min-width: 8rem !important;
+        }
+
+        :global(.multiSelectGroup) {
+          width: 8rem;
+          margin-left: auto;
+
+          :global(.selectDisplay) {
+            height: 2.0625rem !important;
+            min-height: 2.0625rem !important;
+            padding: 0;
+            padding-left: 0.625rem;
+          }
+        }
+      }
+
+      :global(.summary) {
+        overflow: visible;
+        cursor: default;
+      }
+
+      .statusCodeOptionContainer {
+        display: grid;
+        grid-template-columns: min-content min-content;
+        align-items: center;
+        gap: 0.625rem;
+
+        .statusCodeOptionCircle {
+          width: 0.625rem;
+          aspect-ratio: 1 / 1;
+          border-radius: 100%;
         }
       }
     }
 
-    :global(.summary .iconContainer .dropdownIcon) {
-      display: none !important;
+    .methodForm_submitBtn {
+      height: 1.25rem !important;
+      width: 4.25rem;
     }
   }
 }