@digi-frontend/dgate-api-documentation 1.1.4 → 1.1.7

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

@@ -1,188 +0,0 @@
-import React, { useState, useRef } from 'react'
-import { Button, Size, Input } from 'digitinary-ui'
-import SVGLoader from '../../../components/SVGLoader/SVGLoader'
-import {
-  FilterIcon,
-  BookIcon,
-  ApiIcon,
-  SearchIcon,
-  UpArrowIcon,
-  DownArrowIcon,
-} from '../../../assets/icons'
-import Tooltip from '../../../components/Tooltip/Tooltip'
-import CommonDialog from '../../../components/dialog/index'
-import { METHOD_OPTIONS } from '../../../constants/methods.constant'
-import styles from './DocsHeader.module.scss'
-import { OverviewData } from '../../../../src/layout/docsLayout'
-
-const DocsHeader = ({
-  transformedOpenApis,
-  updateFilteredData,
-}: {
-  transformedOpenApis: OverviewData[]
-  updateFilteredData: (filteredItems: OverviewData[], isReset?: boolean) => void
-}) => {
-  const [showSearchFilter, setShowSearchFilter] = useState<boolean>(false)
-  const [apiName, setApiName] = useState<string>('')
-  const [selectedMethods, setSelectedMethods] = useState<any[]>([])
-  const [isMethodDropdownOpen, setIsMethodDropdownOpen] = useState<boolean>(false)
-
-  const handleOpenSearchFilter = (): void => {
-    setShowSearchFilter(true)
-  }
-
-  const handleCloseSearchFilter = (): void => {
-    setShowSearchFilter(false)
-    setIsMethodDropdownOpen(false)
-  }
-
-  const handleApplyFilters = (): void => {
-    // Reset: no filters applied
-    if (!apiName?.trim() && (!selectedMethods || selectedMethods.length === 0)) {
-      updateFilteredData(transformedOpenApis, true)
-      setShowSearchFilter(false)
-      return
-    }
-
-    let filteredItems = [...transformedOpenApis]
-
-    // Filter by API name
-    if (apiName?.trim()) {
-      const lowerApiName = apiName.toLowerCase()
-      filteredItems = filteredItems.filter((api) => api.title.toLowerCase().includes(lowerApiName))
-    }
-
-    // Filter by selected HTTP methods
-    if (selectedMethods?.length) {
-      filteredItems = filteredItems.filter((api) => {
-        const allMethods = Object.values(api.tags || {})
-          .flat()
-          .map((endpoint: any) => endpoint.method?.toLowerCase())
-
-        return selectedMethods.some((method) => allMethods.includes(method.toLowerCase()))
-      })
-    }
-
-    updateFilteredData(filteredItems)
-    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}>
-        <div className={styles.header_content}>
-          <Button
-            variant="outlined"
-            size="small"
-            className={styles.search_filter_btn}
-            onClick={handleOpenSearchFilter}
-          >
-            Search & Filter
-            <SVGLoader src={FilterIcon} />
-          </Button>
-          <div className={styles.nav_buttons}>
-            <Tooltip
-              placement="bottom"
-              offset={[10, 5]}
-              delay={[0, 0]}
-              className="guide-tooltip"
-              content={<div>Coming Soon</div>}
-            >
-              <Button variant="outlined" size="small" className="guide-btn" disabled={true}>
-                <SVGLoader src={BookIcon} />
-                GUIDES
-              </Button>
-            </Tooltip>
-            <Button variant="outlined" size="small" className={styles.api_btn}>
-              <SVGLoader src={ApiIcon} /> &nbsp; API reference
-            </Button>
-          </div>
-        </div>
-      </header>
-      <CommonDialog
-        size="sm"
-        open={showSearchFilter}
-        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)}
-              size={Size.Medium}
-              clearable
-              endAdornment={<SVGLoader src={SearchIcon} />}
-            />
-            <div className="method-container">
-              <label>Method</label>
-              {/* <SelectGroup
-                isMultiple={true}
-                size={Size.Medium}
-                placeholder="Select Method"
-                value={selectedMethods}
-                onChange={(value) => setSelectedMethods(value || [])}
-                options={[
-                  
-                ]}
-                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
-                variant="contained"
-                color="primary"
-                size="large"
-                onClick={handleApplyFilters}
-                className="dialog-submit-btn"
-              >
-                Apply
-              </Button>
-            </div>
-          </div>
-        }
-      />
-    </>
-  )
-}
-
-export default DocsHeader

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

@@ -1,229 +0,0 @@
-import './style.scss'
-import React, { useEffect, useRef } from 'react'
-import SVGLoader from '../../../components/SVGLoader/SVGLoader'
-import { arrowDownGray, arrowRightGray, document, eye } from '../../../assets/icons'
-import { EndpointData, OverviewData } from 'src/layout/docsLayout'
-import { SectionEnum, useSectionToggle } from '../../../../src/context/SectionToggleContext'
-
-const DocsSideMenuTree = ({
-  apis,
-  setActiveItemData,
-  isFirstApiExpanded,
-  setIsFirstApiExpanded,
-  setActiveType,
-  canSelectFirstApi,
-  canFocusSection,
-  setCanFocusSection,
-  activeApiId,
-  setCanSelectFirstApi,
-}: {
-  apis: OverviewData[]
-  setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>
-  activeItemData: OverviewData | EndpointData
-  isFirstApiExpanded: boolean
-  setIsFirstApiExpanded: React.Dispatch<React.SetStateAction<boolean>>
-  setActiveType: React.Dispatch<React.SetStateAction<'OVERVIEW' | 'ENDPOINT'>>
-  activeType: 'OVERVIEW' | 'ENDPOINT'
-  canSelectFirstApi?: boolean
-  canFocusSection: boolean
-  setCanFocusSection: React.Dispatch<React.SetStateAction<boolean>>
-  activeApiId: string
-  setCanSelectFirstApi: React.Dispatch<React.SetStateAction<boolean>>
-}) => {
-  const { expandedSections, toggleSection, generateSectionKey } = useSectionToggle()
-  const sectionRefs = useRef<Record<string, HTMLDivElement | null>>({})
-
-  // Auto-expand first API only once
-  useEffect(() => {
-    if (canSelectFirstApi || !apis?.length || !isFirstApiExpanded) return
-
-    const firstApi = apis[0]
-    toggleSection(firstApi?.apiSpecId, [
-      { type: SectionEnum.API_SECTION, setTo: true },
-      { type: SectionEnum.OVERVIEW, setTo: true },
-    ])
-
-    setActiveItemData(firstApi)
-    setActiveType('OVERVIEW')
-    setIsFirstApiExpanded(false)
-  }, [apis, isFirstApiExpanded])
-
-  useEffect(() => {
-    const activeApi = apis?.find((api) => api.apiSpecId === activeApiId)
-    if (activeApiId && apis.length > 0 && !!activeApi) {
-      toggleSection(activeApi.apiSpecId, [
-        { type: SectionEnum.API_SECTION, setTo: true },
-        { type: SectionEnum.OVERVIEW, setTo: true },
-      ])
-
-      setActiveItemData(activeApi)
-      setActiveType('OVERVIEW')
-      setIsFirstApiExpanded(false)
-      setCanSelectFirstApi(true)
-      setCanFocusSection(true)
-    }
-  }, [activeApiId, apis])
-
-  const renderEndpoints = (endpoints: EndpointData[], api: OverviewData) =>
-    endpoints.map((endpoint, index) => {
-      const key = generateSectionKey({
-        apiId: api.apiSpecId,
-        type: SectionEnum.RESOURCE,
-        id: endpoint.id,
-      })
-      const isExpanded = expandedSections[key]
-
-      return (
-        <div
-          key={index}
-          className={`api-docs-api-tree__endpoint api-docs-api-tree__endpoint--${endpoint.method.toLowerCase()}`}
-          onClick={() => {
-            if (!isExpanded) {
-              setActiveItemData({
-                ...endpoint,
-                api,
-              })
-              setActiveType('ENDPOINT')
-              toggleSection(api.apiSpecId, [{ type: SectionEnum.RESOURCE, id: endpoint.id }], {
-                resetOthers: true,
-                filterKeys: [SectionEnum.RESOURCE, SectionEnum.OVERVIEW],
-              })
-            }
-          }}
-          data-active={isExpanded}
-        >
-          <span className="api-docs-api-tree__endpoint-method">{endpoint.method}</span>
-          <span className="api-docs-api-tree__endpoint-name">{endpoint.path}</span>
-        </div>
-      )
-    })
-
-  const renderSubSection = (
-    tagName: string,
-    data: EndpointData[],
-    api: OverviewData,
-    sectionIndex: number
-  ) => {
-    const sectionKey = generateSectionKey({
-      apiId: api.apiSpecId,
-      type: SectionEnum.TAG_SECTION,
-      index: sectionIndex,
-    })
-    const isSectionExpanded = expandedSections[sectionKey]
-
-    return (
-      <div key={sectionKey} className="api-docs-api-tree__subsection">
-        <div
-          className="api-docs-api-tree__subsection-header"
-          onClick={() =>
-            toggleSection(api.apiSpecId, [{ type: SectionEnum.TAG_SECTION, index: sectionIndex }])
-          }
-        >
-          {isSectionExpanded ? (
-            <SVGLoader src={arrowDownGray} />
-          ) : (
-            <SVGLoader src={arrowRightGray} />
-          )}
-          <span className="api-docs-api-tree__subsection-title">{tagName}</span>
-        </div>
-
-        {isSectionExpanded && (
-          <div className="api-docs-api-tree__endpoints">{renderEndpoints(data, api)}</div>
-        )}
-      </div>
-    )
-  }
-
-  const renderApiSection = (api: OverviewData) => {
-    const sectionKey = generateSectionKey({ apiId: api.apiSpecId, type: SectionEnum.API_SECTION })
-    const endpointsKey = generateSectionKey({
-      apiId: api.apiSpecId,
-      type: SectionEnum.ENDPOINTS_SECTION,
-    })
-    const overviewKey = generateSectionKey({ apiId: api.apiSpecId, type: SectionEnum.OVERVIEW })
-
-    const isApiExpanded = expandedSections[sectionKey]
-    const isEndpointActive = expandedSections[endpointsKey]
-    const isOverviewExpanded = expandedSections[overviewKey]
-    // Scroll to the section if it's expanded
-    if (canFocusSection) {
-      const sectionEl = sectionRefs.current[api.apiSpecId]
-      sectionEl?.scrollIntoView({ behavior: 'smooth', block: 'start' })
-      setCanFocusSection(false)
-    }
-
-    return (
-      <div
-        key={api.apiSpecId}
-        className="api-docs-api-tree__section"
-        data-active={isEndpointActive || isOverviewExpanded}
-        ref={(el) => {
-          sectionRefs.current[api.apiSpecId] = el
-        }}
-      >
-        <div
-          className="api-docs-api-tree__section-header"
-          onClick={() => toggleSection(api.apiSpecId, [{ type: SectionEnum.API_SECTION }])}
-        >
-          {isApiExpanded ? <SVGLoader src={arrowDownGray} /> : <SVGLoader src={arrowRightGray} />}
-          <SVGLoader src={document} />
-          <span className="api-docs-api-tree__section-title">{api.title}</span>
-        </div>
-
-        {isApiExpanded && (
-          <>
-            <div
-              className="api-docs-api-tree__section__overview"
-              onClick={() => {
-                if (!isOverviewExpanded) {
-                  toggleSection(api.apiSpecId, [{ type: SectionEnum.OVERVIEW }], {
-                    resetOthers: true,
-                    filterKeys: [SectionEnum.RESOURCE],
-                  })
-                  setActiveItemData(api)
-                  setActiveType('OVERVIEW')
-                }
-              }}
-              data-active={isOverviewExpanded}
-            >
-              <SVGLoader src={eye} />
-              <span>Overview</span>
-            </div>
-
-            <div
-              className="api-docs-api-tree__section__endpoints"
-              onClick={() =>
-                toggleSection(api.apiSpecId, [{ type: SectionEnum.ENDPOINTS_SECTION }])
-              }
-              data-active={isEndpointActive && !isOverviewExpanded}
-            >
-              {expandedSections[endpointsKey] ? (
-                <SVGLoader src={arrowDownGray} />
-              ) : (
-                <SVGLoader src={arrowRightGray} />
-              )}
-              <span>Endpoints</span>
-            </div>
-
-            {expandedSections[endpointsKey] && (
-              <div className="api-docs-api-tree__subsections">
-                {Object.entries(api.tags)
-                  .filter(([, endpoints]) => endpoints.length > 0)
-                  .sort(([a], [b]) =>
-                    a === 'default' ? 1 : b === 'default' ? -1 : a.localeCompare(b)
-                  )
-                  .map(([tagName, data], i) =>
-                    renderSubSection(tagName, data as EndpointData[], api, i)
-                  )}
-              </div>
-            )}
-          </>
-        )}
-      </div>
-    )
-  }
-
-  return <aside className="api-docs-api-tree">{apis.map((api) => renderApiSection(api))}</aside>
-}
-
-export default DocsSideMenuTree

package/src/layout/docsComponents/index.tsx

@@ -1,28 +0,0 @@
-import React from 'react'
-import DocsHeader from './DocsHeader/DocsHeader'
-import DocsSideMenuTree from './DocsSideMenuTree/DocsSideMenuTree'
-import DocsContent from './DocsContent/DocsContent'
-import DocsAside from './DocsAside/DocsAside'
-import './index.scss'
-
-type LayoutProps = {
-  children: React.ReactNode
-}
-
-type CompoundLayout = React.FC<LayoutProps> & {
-  DocsHeader: typeof DocsHeader
-  DocsSideMenuTree: typeof DocsSideMenuTree
-  DocsContent: typeof DocsContent
-  DocsAside: typeof DocsAside
-}
-
-const Layout = (({ children }: LayoutProps) => {
-  return <div className="api-docs-layout">{children}</div>
-}) as CompoundLayout
-
-Layout.DocsHeader = DocsHeader
-Layout.DocsSideMenuTree = DocsSideMenuTree
-Layout.DocsContent = DocsContent
-Layout.DocsAside = DocsAside
-
-export default Layout

package/src/layout/docsLayout.tsx

@@ -1,123 +0,0 @@
-import React, { JSX, useEffect, useRef, useState } from 'react'
-import Layout from './docsComponents'
-import { HTTPMethod, OpenAPIFile, Parameter, RequestBody, Responses } from '@entities/openApi'
-import { transformOpenApiToDocs } from '../helpers/docs.helper'
-import { ApiSpecModel } from '@entities/index'
-import stableStringify from 'fast-json-stable-stringify'
-import { SectionToggleProvider } from '../../src/context/SectionToggleContext'
-import { ToastContainer } from 'react-toastify'
-
-interface ILayoutProps {
-  apis?: ApiSpecModel[]
-  activeApiId?: string
-  onProductNavigate?: (productId: number) => void
-}
-
-export interface TagData {
-  id: string
-  method: HTTPMethod
-  path: string
-  tags: string[]
-  responses: Responses
-  summary?: string
-  description: string
-  parameters?: Parameter[]
-  requestBody?: RequestBody
-}
-
-export interface EndpointData extends TagData {
-  api: OverviewData
-}
-
-export interface OverviewData extends Omit<ApiSpecModel, 'metaData'> {
-  description: string
-  title: string
-  version: string
-  tags: Record<string, TagData[]>
-  servers: OpenAPIFile['servers']
-}
-
-function areEqual(prev: ILayoutProps, next: ILayoutProps): boolean {
-  return (
-    stableStringify(prev.apis ?? []) === stableStringify(next.apis ?? []) &&
-    prev.activeApiId === next.activeApiId
-  )
-}
-
-const DocsLayout = ({ apis, activeApiId, onProductNavigate }: ILayoutProps): JSX.Element => {
-  const [transformedOpenApis, setTransformedOpenApis] = useState<OverviewData[]>([])
-  const [isFirstApiExpanded, setIsFirstApiExpanded] = useState(true)
-  const [activeItemData, setActiveItemData] = useState<
-    OverviewData | EndpointData | Record<string, never>
-  >({})
-  const [activeType, setActiveType] = useState<'OVERVIEW' | 'ENDPOINT'>('OVERVIEW')
-  const allData = useRef([])
-  const [pending, setPending] = useState(true)
-  const [canSelectFirstApi, setCanSelectFirstApi] = useState(false)
-  const [canFocusSection, setCanFocusSection] = useState(false)
-
-  useEffect(() => {
-    if (transformedOpenApis.length === 0) {
-      setCanSelectFirstApi(!!activeApiId)
-      const t = structuredClone(apis)
-        ?.map((o3) => transformOpenApiToDocs(o3))
-        .sort((a, b) => a.title.toLowerCase().localeCompare(b.title.toLowerCase()))
-      setTransformedOpenApis(t)
-      allData.current = t
-      if (t.length > 0) {
-        setPending(false)
-      }
-    }
-  }, [apis])
-
-  const updateFilteredData = (filteredItems: OverviewData[], isReset = false) => {
-    if (isReset) {
-      setTransformedOpenApis(allData.current)
-      return
-    }
-    setTransformedOpenApis(filteredItems)
-  }
-
-  return (
-    <Layout>
-      <SectionToggleProvider>
-        <Layout.DocsHeader
-          transformedOpenApis={transformedOpenApis}
-          updateFilteredData={updateFilteredData}
-        />
-        {!pending && (
-          <Layout.DocsSideMenuTree
-            apis={transformedOpenApis}
-            setActiveItemData={setActiveItemData}
-            activeItemData={activeItemData as OverviewData | EndpointData}
-            isFirstApiExpanded={isFirstApiExpanded}
-            activeType={activeType}
-            setIsFirstApiExpanded={setIsFirstApiExpanded}
-            setActiveType={setActiveType}
-            canSelectFirstApi={canSelectFirstApi}
-            canFocusSection={canFocusSection}
-            setCanFocusSection={setCanFocusSection}
-            activeApiId={activeApiId}
-            setCanSelectFirstApi={setCanSelectFirstApi}
-          />
-        )}
-
-        {!pending && Object.keys(activeItemData).length > 0 && (
-          <Layout.DocsContent
-            data={activeItemData as OverviewData | EndpointData}
-            activeType={activeType}
-            setActiveItemData={setActiveItemData}
-            setActiveType={setActiveType}
-            onProductNavigate={onProductNavigate}
-            apis={transformedOpenApis}
-          />
-        )}
-        {activeType === 'ENDPOINT' && <Layout.DocsAside data={activeItemData as EndpointData} />}
-      </SectionToggleProvider>
-
-      <ToastContainer />
-    </Layout>
-  )
-}
-
-export default React.memo(DocsLayout, areEqual)

package/src/layout/layout.module.css

@@ -1,65 +0,0 @@
-.docsLayout {
-  display: flex;
-  flex-direction: column;
-  overflow: hidden;
-  height: 100vh;
-  max-height: 100%;
-
-  .apiDocAlert {
-    border-radius: 0;
-    z-index: 3;
-  }
-
-  .layoutContainer {
-    display: grid;
-    grid-template-columns: 60% 40%;
-    width: 100%;
-    height: 100%;
-    max-width: 100%;
-    max-height: 100%;
-    overflow: hidden;
-
-    .editorSide {
-      background-color: #fff;
-      padding-bottom: 1.25rem;
-      .editorSectionHead_title {
-        position: sticky;
-        top: 0;
-        z-index: 1399 !important;
-      }
-      .editorSectionHead,
-      .editorSectionHead_title {
-        span {
-          width: 100%;
-        }
-
-        .editorSectionHead_content {
-          display: flex;
-          justify-content: space-between;
-          align-items: center;
-
-          button {
-            width: 6.25rem;
-          }
-        }
-      }
-    }
-
-    .livePreviewSide {
-      background-color: #f8f9fb;
-      padding: 1.25rem 1.875rem;
-    }
-
-    .docSide {
-      max-height: 100%;
-      overflow-y: overlay;
-      overflow-x: clip;
-      scroll-behavior: smooth;
-    }
-  }
-
-  :global(.textArea .inputField),
-  :global(.inputContainer .inputWrapper .innerInputContainer .input) {
-    padding-inline-end: 2.5rem;
-  }
-}