@digi-frontend/dgate-api-documentation 1.0.1 → 1.0.5

package/src/layout/docsComponents/Codebox/Codebox.tsx

@@ -1,61 +0,0 @@
-import React, { useState } from 'react'
-import { Light as SyntaxHighlighter } from 'react-syntax-highlighter'
-import json from 'react-syntax-highlighter/dist/esm/languages/hljs/json'
-import * as hljs from 'react-syntax-highlighter/dist/esm/styles/hljs'
-import styles from './style.module.scss'
-import SVGLoader from '../../../components/SVGLoader/SVGLoader'
-import { Copy } from '../../../assets/icons'
-import { copyToClipboard } from '../../../utils'
-
-SyntaxHighlighter.registerLanguage('json', json)
-
-const Codebox = ({ code }: { code: string }) => {
-  const [theme, setTheme] = useState<'LIGHT' | 'DARK'>('DARK')
-
-  return (
-    <div className={styles.codebox}>
-      <div className={styles.codebox_header}>
-        <div
-          role="button"
-          tabIndex={-1}
-          onClick={() => theme !== 'LIGHT' && setTheme('LIGHT')}
-          className={`${styles.codebox_header_themeToggle} ${styles.codebox_header_themeToggle_light}`}
-          title="Light theme"
-        ></div>
-        <div
-          role="button"
-          tabIndex={-1}
-          onClick={() => theme !== 'DARK' && setTheme('DARK')}
-          className={`${styles.codebox_header_themeToggle} ${styles.codebox_header_themeToggle_dark}`}
-          title="Dark theme"
-        ></div>
-        <SVGLoader
-          src={Copy}
-          width="0.75rem"
-          height="0.75rem"
-          className={styles.codebox_header_copyIcon}
-          onClick={() => copyToClipboard(code)}
-        />
-      </div>
-      <SyntaxHighlighter
-        language="json"
-        style={theme === 'LIGHT' ? hljs.stackoverflowLight : hljs.stackoverflowDark}
-        showLineNumbers
-        wrapLines
-        customStyle={{
-          margin: 0,
-          height: '13.75rem',
-          overflowY: 'auto',
-          padding: '0.75rem 1rem 0 1.5rem',
-          backgroundColor: theme === 'DARK' ? '#455162' : '#F7F7F7',
-          fontSize: '0.75rem',
-        }}
-        lineProps={{ className: 'custom-code-line' }}
-      >
-        {code}
-      </SyntaxHighlighter>
-    </div>
-  )
-}
-
-export default Codebox

package/src/layout/docsComponents/Codebox/style.module.scss

@@ -1,43 +0,0 @@
-.codebox {
-  border-radius: 0.25rem;
-  overflow: hidden;
-
-  &_header {
-    display: flex;
-    align-items: center;
-    gap: 0.25rem;
-    padding-left: 0.5rem;
-    height: 1.75rem;
-    border: 1px solid #bbbec5;
-    border-top-right-radius: 0.25rem;
-    border-top-left-radius: 0.25rem;
-
-    &_themeToggle {
-      width: 0.75rem;
-      min-width: 0.75rem;
-      aspect-ratio: 1 / 1;
-      border: 1px solid transparent;
-      border-radius: 100%;
-      cursor: pointer;
-
-      &_dark {
-        background-color: #455162;
-        border-color: #6b7280;
-      }
-
-      &_light {
-        background-color: #edf1fb;
-        border-color: #6b7280;
-      }
-    }
-
-    &_copyIcon {
-      cursor: pointer;
-    }
-  }
-
-  :global(.custom-code-line),
-  :global(.custom-code-line span) {
-    font-family: 'Cascadia Code', sans-serif;
-  }
-}

package/src/layout/docsComponents/DocsAside/DocsAside.tsx

@@ -1,93 +0,0 @@
-import React, { useState } from 'react'
-import { EndpointData } from 'src/layout/docsLayout'
-import Codebox from '../Codebox/Codebox'
-import { Option, SelectGroup } from 'digitinary-ui'
-import { httpStatusCodes } from '../../../constants/index'
-import { handleStatusColor } from '../../../helpers/methodAccordion.helper'
-import styles from './style.module.scss'
-
-const httpStatusCodeOptions: Option[] = httpStatusCodes.map((code) => ({
-  label: (
-    <div className={styles.statusCodeOptionContainer}>
-      <div
-        className={styles.statusCodeOptionCircle}
-        style={{ backgroundColor: handleStatusColor(code) }}
-      ></div>
-      <span>{code}</span>
-    </div>
-  ),
-  value: String(code),
-}))
-
-const DocsAside = ({ data }: { data: EndpointData }) => {
-  const [selectedResStatusCode, setSelectedResStatusCode] = useState(httpStatusCodeOptions[4])
-  const currentResponse = Object.entries(data.responses)
-    .map(([code, data]) => ({ code, data }))
-    .find((res) => res.code === selectedResStatusCode.value)
-
-  const stringifyRequestBody = () => {
-    if (data?.requestBody?.content) {
-      const contentKey = Object.keys(data?.requestBody?.content)[0]
-      return JSON.stringify(data?.requestBody?.content[contentKey]?.schema?.properties, null, 2)
-    } else {
-      return '{}'
-    }
-  }
-
-  const stringifyResponseBody = () => {
-    if (currentResponse?.data) {
-      const contentKey = Object.keys(currentResponse.data?.content)[0]
-      return JSON.stringify(currentResponse.data?.content[contentKey]?.schema?.properties, null, 2)
-    } else {
-      return '{}'
-    }
-  }
-
-  return (
-    <aside className={styles.apiDocsAside}>
-      <h2 className={styles.apiDocsAside_title}>{data.summary}</h2>
-      <h4 className={styles.apiDocsAside_subtitle}>
-        <span className={styles.apiDocsAside_subtitle_method} data-method={data.method}>
-          {data.method}
-        </span>{' '}
-        <span>{data.path}</span>
-      </h4>
-      {!['delete', 'get'].includes(data.method) && data?.requestBody?.content && (
-        <div className={styles.codeboxSection}>
-          <div className={styles.codeboxHeader}>
-            <h6 className={styles.codeboxTitle}>Request</h6>
-          </div>
-
-          <Codebox code={stringifyRequestBody()} />
-        </div>
-      )}
-      {Object.keys(data?.responses || {})?.length > 0 && (
-        <div className={styles.codeboxSection}>
-          <div className={`${styles.codeboxHeader}`}>
-            <h6 className={styles.codeboxTitle}>Response</h6>
-            <SelectGroup
-              size="small"
-              withSearch={false}
-              isMultiple={false}
-              clearable={false}
-              placeholder="200"
-              options={[
-                {
-                  list: httpStatusCodeOptions,
-                },
-              ]}
-              value={selectedResStatusCode}
-              onChange={(value) => {
-                setSelectedResStatusCode(value)
-              }}
-            />
-          </div>
-
-          <Codebox code={stringifyResponseBody()} />
-        </div>
-      )}
-    </aside>
-  )
-}
-
-export default DocsAside

package/src/layout/docsComponents/DocsAside/style.module.scss

@@ -1,113 +0,0 @@
-.apiDocsAside {
-  width: 22.5rem;
-  padding: 3rem 1.5rem;
-  background-color: #f0f1f2;
-
-  &_title {
-    font-size: 1.5rem;
-    line-height: 2rem;
-    font-weight: 600;
-    color: #12131a;
-    margin-bottom: 0.5rem;
-  }
-
-  &_subtitle {
-    margin-bottom: 2rem;
-
-    > span {
-      font-size: 1.25rem;
-      line-height: 1.75rem;
-      font-weight: 400;
-    }
-
-    &_method {
-      &[data-method='get'] {
-        color: #3a6cd1;
-      }
-
-      &[data-method='post'] {
-        color: #3aaa35;
-      }
-
-      &[data-method='put'] {
-        color: #faad14;
-      }
-
-      &[data-method='delete'] {
-        color: #da3f3f;
-      }
-
-      &[data-method='option'] {
-        color: #495d97;
-      }
-
-      &[data-method='head'] {
-        color: #9461c9;
-      }
-
-      &[data-method='patch'] {
-        color: #58e2c2;
-      }
-    }
-  }
-
-  .codeboxSection {
-    .codeboxHeader {
-      height: 2rem;
-      display: flex;
-      justify-content: space-between;
-      margin-bottom: 0.25rem;
-
-      h6 {
-        font-size: 1rem;
-        line-height: 1.25rem;
-        font-weight: 500;
-        color: #616874;
-      }
-    }
-
-    &:nth-of-type(2) {
-      margin-top: 3rem;
-    }
-
-    :global(.multiSelectGroup) {
-      :global(.selectDisplay) {
-        padding: 0;
-
-        :global(.select-label-container) {
-          min-width: 100%;
-          padding: 0;
-        }
-      }
-
-      :global(.optionsList .option) {
-        height: 1.5rem;
-        padding: 0;
-      }
-
-      .statusCodeOptionContainer {
-        display: flex;
-        align-items: center;
-        gap: 0.625rem;
-        padding-left: 0.75rem;
-
-        .statusCodeOptionCircle {
-          width: 0.625rem;
-          min-width: 0.625rem;
-          aspect-ratio: 1 / 1;
-          border-radius: 100%;
-        }
-      }
-    }
-  }
-
-  :global(.multiSelectGroup .selectDisplay),
-  :global(.multiSelectGroup) {
-    width: 6.25rem !important;
-    height: 1.5rem !important;
-  }
-
-  :global(.multiSelectGroup .selectDisplay .displayValueContainer .iconsContainer) {
-    padding-right: 0.75rem !important;
-  }
-}

package/src/layout/docsComponents/DocsContent/DocsContent.tsx

@@ -1,51 +0,0 @@
-import React, { useEffect, useRef } from 'react'
-import './style.scss'
-import { OverviewPage } from './OverviewPage'
-import { EndpointPage } from './EndpointPage'
-import { EndpointData, OverviewData } from 'src/layout/docsLayout'
-
-const DocsContent = ({
-  data,
-  activeType,
-  setActiveItemData,
-  setActiveType,
-  onProductNavigate,
-  apis,
-}: {
-  data: OverviewData | EndpointData
-  activeType: 'OVERVIEW' | 'ENDPOINT'
-  setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>
-  setActiveType: React.Dispatch<React.SetStateAction<'OVERVIEW' | 'ENDPOINT'>>
-  onProductNavigate?: (productId: number) => void
-  apis: OverviewData[]
-}) => {
-  const containerRef = useRef(null)
-
-  useEffect(() => {
-    // This will scroll to the top when changing the overview
-    if (activeType === 'OVERVIEW' && containerRef?.current) {
-      containerRef?.current?.scrollTo({ top: 0, behavior: 'smooth' })
-    }
-  }, [data, activeType])
-  return (
-    <main ref={containerRef}>
-      {activeType === 'OVERVIEW' ? (
-        <OverviewPage
-          data={data as OverviewData}
-          setActiveItemData={setActiveItemData}
-          setActiveType={setActiveType}
-          onProductNavigate={onProductNavigate}
-          apis={apis}
-        />
-      ) : (
-        <EndpointPage
-          data={data as EndpointData}
-          setActiveType={setActiveType}
-          setActiveItemData={setActiveItemData}
-        />
-      )}
-    </main>
-  )
-}
-
-export default DocsContent

package/src/layout/docsComponents/DocsContent/EndpointPage/index.tsx

@@ -1,236 +0,0 @@
-import SVGLoader from '../../../../components/SVGLoader/SVGLoader'
-import {
-  ArrowBack,
-  CopySticker,
-  DownArrowIcon,
-  RequestOption,
-} from '../../../../assets/icons/index'
-import { SelectGroup } from 'digitinary-ui'
-import { useEffect, useState } from 'react'
-import { EndpointData, OverviewData } from 'src/layout/docsLayout'
-import { handleStatusColor } from '../../../../helpers/methodAccordion.helper'
-import { httpStatusCodes } from '../../../../constants/index'
-import styles from '../../Codebox/style.module.scss'
-import Tooltip from '../../../../components/Tooltip/Tooltip'
-import './style.scss'
-import { SectionEnum, useSectionToggle } from '../../../../../src/context/SectionToggleContext'
-import { capitalizeFirstLetter } from '../../../../../src/utils'
-
-export const EndpointPage = ({
-  data,
-  setActiveType,
-  setActiveItemData,
-}: {
-  data: EndpointData
-  setActiveType: React.Dispatch<React.SetStateAction<'OVERVIEW' | 'ENDPOINT'>>
-  setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>
-}) => {
-  const [activeTab, setActiveTab] = useState('header')
-  const { toggleSection } = useSectionToggle()
-
-  const httpStatusCodeOptions = httpStatusCodes.map((code) => ({
-    label: (
-      <div className={'statusCodeOptionContainer'}>
-        <div
-          className={'statusCodeOptionCircle'}
-          style={{ backgroundColor: handleStatusColor(code) }}
-        ></div>
-        <span>{code}</span>
-      </div>
-    ),
-    value: code,
-  }))
-
-  const [expanded, setExpanded] = useState(null)
-  const [selectedResStatusCode, setSelectedResStatusCode] = useState(httpStatusCodeOptions[4])
-  const [headersList, setHeadersList] = useState({})
-  const requestTableData = (data?.parameters || []).filter(
-    (param) => param.in?.toLowerCase() === activeTab.toLowerCase()
-  )
-
-  useEffect(() => {
-    if (selectedResStatusCode && selectedResStatusCode.value) {
-      const headerObj = data?.responses[selectedResStatusCode.value]
-      setHeadersList(headerObj?.headers)
-    }
-  }, [selectedResStatusCode])
-
-  // ? TODO: 'body' should be returned after discussing with PO
-
-  return (
-    <div className="api-details-expanded">
-      <div className="test-button">
-        <button
-          className="back-button"
-          onClick={() => {
-            toggleSection(data.api.apiSpecId, [{ type: SectionEnum.OVERVIEW, setTo: true }], {
-              resetOthers: true,
-              filterKeys: [SectionEnum.RESOURCE],
-            })
-            setActiveType('OVERVIEW')
-            setActiveItemData(data.api)
-          }}
-        >
-          <SVGLoader src={ArrowBack} />
-        </button>
-
-        <Tooltip content="Comming soon">
-          <button className="disabled">Test</button>
-        </Tooltip>
-      </div>
-      <h3>{data.api.title}</h3>
-      <h1 className="api-title">{data?.summary}</h1>
-      <div className="url-box">
-        <div style={{ textAlign: 'center' }}>
-          <span className={`method-label ${data?.method?.toLowerCase()}`}>{data.method}</span>
-          <span className="url-text">{data?.path}</span>
-        </div>
-        <span className="icon" onClick={() => navigator.clipboard.writeText(data?.path)}>
-          <SVGLoader src={CopySticker} />
-        </span>
-      </div>
-
-      <p className="api-desc">{data?.description || 'No Description'}</p>
-
-      <h3>Request</h3>
-
-      <div className="request-section">
-        <div className="request-tabs">
-          {['header', 'path', 'query'].map((tab) => (
-            <button
-              key={tab}
-              className={`tab ${activeTab === tab ? 'active' : ''}`}
-              onClick={() => setActiveTab(tab)}
-            >
-              <SVGLoader src={RequestOption} className="icon-left" />
-              <span className="tab-label">
-                {tab === 'requestBody'
-                  ? 'Request Body'
-                  : tab.charAt(0).toUpperCase() + tab.slice(1)}
-              </span>
-            </button>
-          ))}
-        </div>
-
-        {
-          <div className="table-wrapper">
-            <table className="param-table">
-              <thead>
-                <tr>
-                  <th className="head-table-label">Parameter Name</th>
-                  <th className="head-table-label">Required</th>
-                  <th className="head-table-label">Type</th>
-                  <th className="head-table-label">Enum</th>
-                  <th className="head-table-label">Description</th>
-                </tr>
-              </thead>
-              <tbody>
-                {data.parameters
-                  ?.filter((p) => p.in?.toLowerCase() === activeTab.toLowerCase())
-                  .map((row, index) => (
-                    <tr key={index}>
-                      <td>{row.name}</td>
-                      <td>{row.required ? 'True' : 'False'}</td>
-                      <td style={{ textTransform: 'capitalize' }}>
-                        <span>{row?.schema?.type || '-'}</span>
-                        {row?.schema?.type === 'array' && row?.schema?.items?.type && (
-                          <span style={{ color: '#616874', fontSize: '0.75rem' }}>
-                            _{capitalizeFirstLetter(row.schema?.items?.type)}
-                          </span>
-                        )}
-                      </td>
-                      <td>{Array.isArray(row.schema?.enum) ? row.schema.enum.join(' / ') : '-'}</td>
-                      <td className="desc-cell">
-                        <div className={`desc-text ${expanded === index ? 'expanded' : ''}`}>
-                          {row.description || 'No description'}
-                        </div>
-                        <button
-                          className="desc-toggle"
-                          onClick={() => setExpanded(expanded === index ? null : index)}
-                        >
-                          <SVGLoader
-                            src={DownArrowIcon}
-                            className={expanded === index ? 'rotated' : ''}
-                          />
-                        </button>
-                      </td>
-                    </tr>
-                  ))}
-              </tbody>
-            </table>
-          </div>
-        }
-      </div>
-
-      <div className="response-section">
-        <h3>Response</h3>
-
-        <div>
-          <div style={{ height: '0.5rem', width: '7.5rem', marginLeft: 'auto' }}>
-            {Object.keys(data?.responses || {})?.length > 0 && (
-              <div className={'codeboxSection'}>
-                <div className={`${'codeboxHeader'}`}>
-                  <SelectGroup
-                    size="small"
-                    withSearch={false}
-                    isMultiple={false}
-                    clearable={false}
-                    placeholder="200"
-                    options={[
-                      {
-                        list: httpStatusCodeOptions,
-                      },
-                    ]}
-                    value={selectedResStatusCode}
-                    onChange={(value) => {
-                      setSelectedResStatusCode(value)
-                    }}
-                  />
-                </div>
-              </div>
-            )}
-          </div>
-          <button className="tab active ">
-            <SVGLoader src={RequestOption} className="icon-left" />
-            Header
-          </button>
-        </div>
-
-        <div className="table-wrapper">
-          <table className="param-table">
-            <thead>
-              <tr>
-                <th className="head-table-label">Header Name</th>
-                <th className="head-table-label">Required</th>
-                <th className="head-table-label">Type</th>
-                <th className="head-table-label">Enum</th>
-                <th className="head-table-label">Description</th>
-              </tr>
-            </thead>
-            <tbody>
-              {!!headersList &&
-                Object.keys(headersList) &&
-                Object.keys(headersList).map((key) => (
-                  <tr>
-                    <td>{key}</td>
-                    <td>{headersList[key]?.required.toString()}</td>
-                    <td style={{ textTransform: 'capitalize' }}>
-                      <span>{headersList[key]?.schema?.type || '-'}</span>
-                      {headersList[key]?.schema?.type === 'array' &&
-                        headersList[key]?.schema?.items?.type && (
-                          <span style={{ color: '#616874', fontSize: '0.75rem' }}>
-                            _{capitalizeFirstLetter(headersList[key]?.schema?.items?.type)}
-                          </span>
-                        )}
-                    </td>
-                    <td>{headersList[key]?.schema?.enum?.join('/')}</td>
-                    <td>{headersList[key]?.description}</td>
-                  </tr>
-                ))}
-            </tbody>
-          </table>
-        </div>
-      </div>
-    </div>
-  )
-}