@digi-frontend/dgate-api-documentation 1.0.47 → 1.0.50

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

@@ -4,10 +4,11 @@ import SVGLoader from '../../../components/SVGLoader/SVGLoader'
 import { CopySticker } from '../../../assets/icons/index'
 import { TagPage } from './TagPage'
 import { EndpointPage } from './EndpointPage'
+import { EndpointData, OverviewData } from 'src/layout/docsLayout'
 
-const DocsContent = () => {
+const DocsContent = ({ data }: { data: OverviewData | EndpointData }) => {
   const isTagPage = false
-  return <main>{isTagPage ? <TagPage /> : <EndpointPage />}</main>
+  return <main>{!isTagPage ? <TagPage data={data} /> : <EndpointPage data={data} />}</main>
 }
 
 export default DocsContent

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

@@ -8,8 +8,9 @@ import {
 } from '../../../../assets/icons/index'
 import { ArrowIcon, SelectGroup } from 'digitinary-ui'
 import { useState } from 'react'
+import { EndpointData } from 'src/layout/docsLayout'
 
-export const EndpointPage = () => {
+export const EndpointPage = ({ data }) => {
   const [expanded, setExpanded] = useState(null)
 
   const requestTableData = [

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

@@ -1,14 +1,15 @@
 import './style.scss'
 import SVGLoader from '../../../../components/SVGLoader/SVGLoader'
-import { CopySticker } from '../../../../assets/icons/index'
+import { arrowRightGray, CopySticker } from '../../../../assets/icons/index'
+import { OverviewData } from 'src/layout/docsLayout'
 
-export const TagPage = () => {
+export const TagPage = ({ data }) => {
   return (
     <div className="api-details-page">
       <h2 className="welcome">Welcome to</h2>
-      <h1 className="api-title">API Name</h1>
+      <h1 className="api-title">{data.title}</h1>
       <p className="api-version">
-        API Version: <span>2.3.0</span>
+        API Version: <span>{data.version}</span>
       </p>
 
       <div className="custom-url-input">
@@ -33,68 +34,38 @@ export const TagPage = () => {
 
       <h3 className="section-title">Endpoints</h3>
 
-      <div className="endpoint-group">
-        <h4 className="tag-title">Tag 01</h4>
-        <div className="endpoint-list">
-          <div className="endpoint-card">
-            <div className="endpoint-card-header">
-              <span className="method-label get">GET</span>
-              <h5>Endpoint Name</h5>
-            </div>
+      {Object.entries(data.tags).map(([tag, endpoints]) => (
+        <div className="endpoint-group" key={tag}>
+          <h4 className="tag-title">{tag}</h4>
+          <div className="endpoint-list">
+            {endpoints.map((endpoint, idx) => (
+              <div className="endpoint-card" key={`${tag}-${idx}`}>
+                <div>
+                  <div className="endpoint-card-header">
+                    <span className={`method-label ${endpoint.method.toLowerCase()}`}>
+                      {endpoint.method}
+                    </span>
+                    <div className="title-wrapper">
+                      <h5>
+                        {(endpoint.summary || 'Endpoint Name').slice(0, 17)}
+                        {(endpoint.summary?.length ?? 0) > 17 && '...'}
+                      </h5>
+                    </div>
+                  </div>
+                  <div className="endpoint-meta">
+                    <p>{endpoint.path}</p>
+                    <p className="description">{endpoint.description ?? 'No Description '}</p>
+                  </div>
+                </div>
 
-            <div className="endpoint-meta">
-              <p>/auth/login/</p>
-              <p className="description">Login endpoint</p>
-            </div>
-          </div>
-          <div className="endpoint-card">
-            <div className="endpoint-card-header">
-              <span className="method-label patch">PATCH</span>
-              <h5>Endpoint Name</h5>
-            </div>
-            <div className="endpoint-meta">
-              <p>/auth/login/</p>
-              <p className="description">Update login info</p>
-            </div>
-          </div>
-        </div>
-      </div>
-
-      <div className="endpoint-group">
-        <h4 className="tag-title">Tag 02</h4>
-        <div className="endpoint-list">
-          <div className="endpoint-card">
-            <div className="endpoint-card-header">
-              <span className="method-label post">POST</span>
-              <h5>Endpoint Name</h5>
-            </div>
-            <div className="endpoint-meta">
-              <p>/auth/login/</p>
-              <p className="description">Create login session</p>
-            </div>
-          </div>
-          <div className="endpoint-card">
-            <div className="endpoint-card-header">
-              <span className="method-label put">PUT</span>
-              <h5>Endpoint Name</h5>
-            </div>
-            <div className="endpoint-meta">
-              <p>/auth/login/</p>
-              <p className="description">Replace login session</p>
-            </div>
-          </div>
-          <div className="endpoint-card">
-            <div className="endpoint-card-header">
-              <span className="method-label delete">DELETE</span>
-              <h5>Endpoint Name</h5>
-            </div>
-            <div className="endpoint-meta">
-              <p>/auth/login/</p>
-              <p className="description">Delete login session</p>
-            </div>
+                <div className="endpoint-arrow">
+                  <SVGLoader src={arrowRightGray} />
+                </div>
+              </div>
+            ))}
           </div>
         </div>
-      </div>
+      ))}
 
       <div className="versions-section">
         <h4>API Versions</h4>

package/src/layout/docsComponents/DocsContent/TagPage/style.scss

@@ -135,21 +135,36 @@
     }
 
     .endpoint-card {
-      border: 1px solid #ddd;
-      border-radius: 0.5rem;
+      display: flex;
+      align-items: center;
+      justify-content: space-between;
       padding: 1rem;
+      border: 1px solid #e5e7eb;
+      border-radius: 0.5rem;
       background-color: #fff;
+      margin-bottom: 1rem;
+      transition: box-shadow 0.2s ease;
 
       .endpoint-card-header {
         display: flex;
         gap: 1.5rem;
         align-items: flex-start;
 
+        .title-wrapper {
+          flex: 1;
+          width: 8rem;
+          min-width: 0;
+        }
+
         h5 {
           font-size: 1rem;
           font-weight: 400;
           line-height: 1.25rem;
           letter-spacing: 0px;
+          white-space: nowrap;
+          overflow: hidden;
+          text-overflow: ellipsis;
+          max-width: 100%;
         }
       }
 
@@ -161,7 +176,7 @@
         padding: 0.275rem 1.563rem;
         border-radius: 0.188rem;
         display: inline-block;
-        margin-bottom: 0.5rem;
+        margin-bottom: 1rem;
         text-transform: uppercase;
 
         &.get {
@@ -184,6 +199,18 @@
           background-color: #da3f3f;
           color: #ffffff;
         }
+        &.head {
+          background-color: #9461c9;
+          color: #ffffff;
+        }
+        &.trace {
+          background-color: #ffa28f;
+          color: #ffffff;
+        }
+        &.options {
+          background-color: #495d97;
+          color: #ffffff;
+        }
       }
 
       .endpoint-meta {
@@ -208,9 +235,16 @@
           line-height: 1rem;
           font-weight: 400;
           letter-spacing: 0px;
-          margin-top: 1rem;
+          margin-top: 1.5rem;
         }
       }
+      .endpoint-arrow {
+        align-content: center;
+        width: 1rem;
+        height: 1rem;
+        flex-shrink: 0;
+        margin-left: 1rem;
+      }
     }
   }
 
@@ -230,9 +264,11 @@
     .version-list {
       display: flex;
       flex-wrap: wrap;
-      gap: 0.5rem;
+      gap: 1rem;
 
       .version-btn {
+        width: 3.9375rem;
+        height: 3rem;
         padding: 0.4rem 0.8rem;
         border: 1px solid #4d75d9;
         border-radius: 0.375rem;
@@ -240,6 +276,7 @@
         cursor: pointer;
         font-size: 0.875rem;
         color: #4d75d9;
+        box-shadow: inset 0 1px 3px #00000040;
       }
     }
   }

package/src/layout/docsComponents/DocsHeader/DocsHeader.module.scss

@@ -17,7 +17,7 @@
     margin-left: 2.9375rem;
   }
 
-  :global(.search-filter-btn) {
+  .search_filter_btn {
     background-color: #ffffff !important;
     border: 1px solid #e8e9ee !important;
     width: 10.4375rem;
@@ -30,6 +30,10 @@
       color: #000000;
     }
 
+    &:hover {
+      color: #000;
+    }
+
     svg {
       margin-left: 0.5rem;
     }
@@ -55,13 +59,16 @@
     }
   }
 
-  :global(.api-btn) {
+  .api_btn {
     background-color: #ffffff !important;
+    display: flex;
+    flex-direction: row;
+    align-items: center;
     border: none !important;
     box-shadow: 0px 1px 2px rgba(16, 24, 40, 0.05);
     padding: 0.4rem;
-    width: 8.5rem;
-    font-size: 0.9175rem;
+    width: 8.4875rem;
+    font-size: 0.8125rem;
     font-weight: 400;
     line-height: 1.234rem;
     height: 2.25rem;
@@ -135,12 +142,78 @@
     cursor: pointer;
   }
 
+  .name-input {
+    // border-color: #bbbec5 !important;
+    width: 27.875rem;
+    height: 2.5rem;
+    border-radius: 0.5rem;
+    border: 0.0625rem solid #bbbec5;
+    padding-top: 0.5rem;
+    padding-bottom: 0.5rem;
+
+    > div.inputWrapper {
+      border: 0px !important;
+    }
+  }
+
+  .methodList {
+    width: 27.875rem;
+    border-radius: 0.5rem;
+    border: 0.0625rem solid #f0f1f2;
+
+    .method-item {
+      display: flex;
+      flex-direction: row;
+      justify-content: flex-start;
+      align-items: center;
+      gap: 0.5rem;
+      padding-left: 0.75rem;
+      padding-right: 0.75rem;
+      padding-top: 0.5rem;
+      border-radius: 0.5rem;
+      padding-bottom: 0.5rem;
+      border-bottom: 1px solid #f0f1f2;
+      span {
+        font-weight: 400;
+        font-size: 0.875rem;
+      }
+      input {
+        cursor: pointer;
+        width: 1.25rem;
+        height: 1.25rem;
+        border-radius: 0.25rem;
+        border: 1px solid #64748b;
+      }
+    }
+  }
+
   .method-container {
     display: flex;
     flex-direction: column;
     gap: 0.5rem;
     position: relative;
     z-index: 10;
+
+    .typeDdl {
+      cursor: pointer;
+      width: 27.875rem;
+      height: 2.5rem;
+      border-radius: 0.5rem;
+      border: 0.0625rem solid #bbbec5;
+      padding-top: 0.5rem;
+      padding-bottom: 0.5rem;
+      padding-left: 1.3rem;
+      padding-right: 0.75rem;
+      display: flex;
+      justify-content: space-between;
+      align-items: center;
+
+      span {
+        font-weight: 400;
+        font-size: 0.875rem;
+        color: #8390a2;
+      }
+    }
   }
 
   .method-container label {
@@ -157,7 +230,7 @@
     display: flex;
     justify-content: center;
     width: 100%;
-    margin-top: auto;
+    padding-top: 0 !important;
     padding: 1.5rem 0;
   }
 

package/src/layout/docsComponents/DocsHeader/DocsHeader.tsx

@@ -1,7 +1,15 @@
 import React, { useState, useRef } from 'react'
 import { Button, Size, Input, SelectGroup } from 'digitinary-ui'
 import SVGLoader from '../../../components/SVGLoader/SVGLoader'
-import { FilterIcon, BookIcon, ApiIcon, SearchIcon } from '../../../assets/icons'
+import {
+  FilterIcon,
+  BookIcon,
+  ApiIcon,
+  SearchIcon,
+  arrowDownGray,
+  UpArrowIcon,
+  DownArrowIcon,
+} from '../../../assets/icons'
 import Tooltip from '../../../components/Tooltip/Tooltip'
 import CommonDialog from '../../../components/dialog/index'
 import { METHOD_OPTIONS } from '../../../constants/methods.constant'
@@ -11,6 +19,7 @@ const DocsHeader: React.FC = () => {
   const [showSearchFilter, setShowSearchFilter] = useState<boolean>(false)
   const [apiName, setApiName] = useState<string>('')
   const [selectedMethods, setSelectedMethods] = useState<any[]>([])
+  const [methodListOpened, setMethodListOpened] = useState(false)
   const [isMethodDropdownOpen, setIsMethodDropdownOpen] = useState<boolean>(false)
   const selectRef = useRef<any>(null)
 
@@ -27,6 +36,19 @@ const DocsHeader: React.FC = () => {
     setShowSearchFilter(false)
   }
 
+  const handleCheckMethod = (e, method: (typeof METHOD_OPTIONS)[0]) => {
+    const {
+      target: { checked },
+    } = e
+    if (checked) {
+      setSelectedMethods((prev) => [...prev, method.value])
+    } else {
+      if (selectedMethods.includes(method.value)) {
+        setSelectedMethods((prev) => prev.filter((_m) => _m != method.value))
+      }
+    }
+  }
+
   return (
     <>
       <header className={styles.api_docs_header}>
@@ -34,7 +56,7 @@ const DocsHeader: React.FC = () => {
           <Button
             variant="outlined"
             size="small"
-            className="search-filter-btn"
+            className={styles.search_filter_btn}
             onClick={handleOpenSearchFilter}
           >
             Search & Filter
@@ -52,9 +74,8 @@ const DocsHeader: React.FC = () => {
                 GUIDES
               </Button>
             </Tooltip>
-            <Button variant="outlined" size="small" className="api-btn">
-              <SVGLoader src={ApiIcon} />
-              API reference
+            <Button variant="outlined" size="small" className={styles.api_btn}>
+              <SVGLoader src={ApiIcon} /> &nbsp; API reference
             </Button>
           </div>
         </div>
@@ -65,12 +86,14 @@ const DocsHeader: React.FC = () => {
         onClose={handleCloseSearchFilter}
         icon={false}
         withClose={false}
+        noActions
         content={
           <div className={`search-filter-form ${isMethodDropdownOpen ? 'expanded' : ''}`}>
             <div className="search-filter-form__header">
               <p className="search-filter-form__header__title">Search & Filter</p>
             </div>
             <Input
+              className="name-input"
               placeholder="Search by API name"
               value={apiName}
               onChange={(value) => setApiName(value as string)}
@@ -80,23 +103,37 @@ const DocsHeader: React.FC = () => {
             />
             <div className="method-container">
               <label>Method</label>
-              <SelectGroup
+              {/* <SelectGroup
                 isMultiple={true}
                 size={Size.Medium}
                 placeholder="Select Method"
                 value={selectedMethods}
                 onChange={(value) => setSelectedMethods(value || [])}
                 options={[
-                  {
-                    list: METHOD_OPTIONS.map((method) => ({
-                      label: <span style={{ color: method.color }}>{method.label}</span>,
-                      value: method.value,
-                      data: method,
-                    })),
-                  },
+                  
                 ]}
+                withSearch={false}
                 className="method-select custom-select-border"
-              />
+              /> */}
+              <div className="typeDdl" onClick={() => setIsMethodDropdownOpen((prev) => !prev)}>
+                <span>Select Method</span>
+                <SVGLoader src={!isMethodDropdownOpen ? DownArrowIcon : UpArrowIcon} />
+              </div>
+              {isMethodDropdownOpen && (
+                <div className="methodList">
+                  {METHOD_OPTIONS.map((_m) => (
+                    <div className="method-item">
+                      <input
+                        type="checkbox"
+                        className="agreement-checkbox"
+                        checked={selectedMethods.includes(_m.value)}
+                        onChange={(e) => handleCheckMethod(e, _m)}
+                      />
+                      <span style={{ color: _m.color }}>{_m.label}</span>
+                    </div>
+                  ))}
+                </div>
+              )}
             </div>
             <div className="button-container">
               <Button

package/src/layout/docsComponents/DocsSideMenuTree/DocsSideMenuTree.tsx

@@ -8,6 +8,7 @@ const DocsSideMenuTree = ({
   setActiveItemData,
   isFirstApiExpanded,
   setIsFirstApiExpanded,
+  setActiveType,
 }) => {
   const [expandedSections, setExpandedSections] = useState({})
 
@@ -47,17 +48,17 @@ const DocsSideMenuTree = ({
           key={index}
           className={`api-docs-api-tree__endpoint api-docs-api-tree__endpoint--${endpoint.method.toLowerCase()}`}
           onClick={() => {
-            setActiveItemData({
-              ...endpoint,
-              api: {
-                id: api.id,
-                title: api.title,
-                description: api.description,
-                version: api.version,
-              },
-            })
-
             if (!isResourceExpanded) {
+              setActiveItemData({
+                ...endpoint,
+                api: {
+                  id: api.id,
+                  title: api.title,
+                  description: api.description,
+                  version: api.version,
+                },
+              })
+              setActiveType('ENDPOINT')
               toggleSection(api.id, `api-${api.id}-resource-${endpoint.id}`, true, [
                 'resource',
                 'overview',
@@ -85,6 +86,7 @@ const DocsSideMenuTree = ({
       toggleSection(api.id, `api-${api.id}-section`)
       toggleSection(api.id, `api-${api.id}-overview`)
       setActiveItemData(api)
+      setActiveType('OVERVIEW')
     }
 
     return (
@@ -107,8 +109,11 @@ const DocsSideMenuTree = ({
             <div
               className={`api-docs-api-tree__section__overview`}
               onClick={() => {
-                toggleSection(api.id, `api-${api.id}-overview`, true, ['resource'])
-                setActiveItemData(api)
+                if (!isOverviewExpanded) {
+                  toggleSection(api.id, `api-${api.id}-overview`, true, ['resource'])
+                  setActiveItemData(api)
+                  setActiveType('OVERVIEW')
+                }
               }}
               data-active={isOverviewExpanded}
             >

package/src/layout/docsComponents/index.scss

@@ -1,10 +1,12 @@
 .api-docs-layout {
+  @import url('https://fonts.googleapis.com/css2?family=Cascadia+Code:ital,wght@0,200..700;1,200..700&display=swap');
+
   display: grid;
   height: 100vh;
   max-height: 100%;
   width: 100%;
   overflow: hidden;
-  grid-template: 3.125rem auto / 12.5rem 1fr auto;
+  grid-template: 2.625rem auto / 12.5rem 1fr auto;
   padding: 0 !important;
 
   * {

package/src/layout/docsLayout.tsx

@@ -40,16 +40,18 @@ const DocsLayout = ({ openApiJson }: ILayoutProps): JSX.Element => {
   const [transformedOpenApis, setTransformedOpenApis] = useState([])
   const [isFirstApiExpanded, setIsFirstApiExpanded] = useState(true)
   const [activeItemData, setActiveItemData] = useState<OverviewData | EndpointData>()
-
-  // useEffect(() => {
-  //   if (transformedOpenApis.length === 0) {
-  //     setTransformedOpenApis(
-  //       structuredClone(openApiJson)
-  //         ?.map((o3) => transformOpenApiToDocs(o3))
-  //         .sort((a, b) => a.title.toLowerCase().localeCompare(b.title.toLowerCase()))
-  //     )
-  //   }
-  // }, [openApiJson])
+  const [activeType, setActiveType] = useState<'OVERVIEW' | 'ENDPOINT'>()
+  const [pending, setPending] = useState(true)
+  useEffect(() => {
+    if (transformedOpenApis.length === 0) {
+      setTransformedOpenApis(
+        structuredClone(openApiJson)
+          ?.map((o3) => transformOpenApiToDocs(o3))
+          .sort((a, b) => a.title.toLowerCase().localeCompare(b.title.toLowerCase()))
+      )
+      setPending(false)
+    }
+  }, [openApiJson])
 
   return (
     <Layout>
@@ -59,9 +61,10 @@ const DocsLayout = ({ openApiJson }: ILayoutProps): JSX.Element => {
         setActiveItemData={setActiveItemData}
         isFirstApiExpanded={isFirstApiExpanded}
         setIsFirstApiExpanded={setIsFirstApiExpanded}
+        setActiveType={setActiveType}
       />
-      <Layout.DocsContent data={activeItemData} />
-      <Layout.DocsAside />
+      {!pending && <Layout.DocsContent data={activeItemData} />}
+      {activeType === 'ENDPOINT' && <Layout.DocsAside data={activeItemData} />}
     </Layout>
   )
 }

package/src/layout/layout.module.css

@@ -22,9 +22,13 @@
     .editorSide {
       background-color: #fff;
       padding-bottom: 1.25rem;
-
-      .editorSectionHead {
-
+      .editorSectionHead_title {
+        position: sticky;
+        top: 0;
+        z-index: 99999 !important;
+      }
+      .editorSectionHead,
+      .editorSectionHead_title {
         span {
           width: 100%;
         }
@@ -38,7 +42,6 @@
             width: 6.25rem;
           }
         }
-
       }
     }
 
@@ -59,4 +62,4 @@
   :global(.inputContainer .inputWrapper .innerInputContainer .input) {
     padding-inline-end: 2.5rem;
   }
-}
+}

package/src/layout/layout.tsx

@@ -58,10 +58,10 @@ const Layout = ({ openApiJson, handleSave, setIsFormDirty, openApiErrors }: ILay
       <div className={styles.layoutContainer}>
         <div className={`${styles.editorSide} ${styles.docSide}`}>
           <SectionHead
-            className={styles.editorSectionHead}
+            className={styles.editorSectionHead_title}
             text={
               <div className={styles.editorSectionHead_content}>
-                API Information
+                API Documentation
                 <Button
                   className={styles.methodForm_submitBtn}
                   size="medium"
@@ -99,7 +99,7 @@ const Layout = ({ openApiJson, handleSave, setIsFormDirty, openApiErrors }: ILay
                       }}
                       isOpen={openMethodIndex === methodIndex}
                       setIsOpen={(open) => setOpenMethodIndex(open ? methodIndex : null)}
-                      errors={formik.errors.paths?.[pathIndex]?.methods?.[methodIndex]}
+                      errors={(formik.errors.paths?.[pathIndex] as any)?.methods?.[methodIndex]}
                     />
                   ))}
               </>

package/src/utils/index.ts

@@ -0,0 +1,7 @@
+export const copyToClipboard = async (text: string) => {
+  try {
+    await navigator.clipboard.writeText(text)
+  } catch (err) {
+    return err
+  }
+}

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

@@ -1,3 +0,0 @@
-.api-docs-aside {
-  background-color: #f0f1f2;
-}