api-ref: custom API reference (#4770)

* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
2023-08-15 18:07:54 +03:00
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
@@ -0,0 +1,150 @@
+import OpenAPIParser from "@readme/openapi-parser"
+import algoliasearch from "algoliasearch"
+import type { ExpandedDocument, Operation } from "../../../types/openapi"
+import path from "path"
+import getPathsOfTag from "../../../utils/get-paths-of-tag"
+import getSectionId from "../../../utils/get-section-id"
+import { NextResponse } from "next/server"
+import { JSDOM } from "jsdom"
+import capitalize from "../../../utils/capitalize"
+import getUrl from "../../../utils/get-url"
+
+export async function GET() {
+  const algoliaClient = algoliasearch(
+    process.env.NEXT_PUBLIC_ALGOLIA_APP_ID || "",
+    process.env.ALGOLIA_WRITE_API_KEY || ""
+  )
+  const index = algoliaClient.initIndex(
+    process.env.NEXT_PUBLIC_ALGOLIA_INDEX_NAME || ""
+  )
+
+  // retrieve tags and their operations to index them
+  const indices: Record<string, any>[] = []
+  for (const area of ["store", "admin"]) {
+    const defaultIndexData = {
+      version: ["current"],
+      lang: "en",
+      _tags: ["api", area],
+    }
+    // find and parse static headers from pages
+    const dom = await JSDOM.fromURL(getUrl(area))
+    const headers = dom.window.document.querySelectorAll("h2")
+    headers.forEach((header) => {
+      if (!header.textContent) {
+        return
+      }
+
+      const objectID = getSectionId([header.textContent])
+      const url = getUrl(area, objectID)
+      indices.push({
+        objectID: getObjectId(area, `${objectID}-mdx-section`),
+        hierarchy: getHierarchy(area, [header.textContent]),
+        type: `content`,
+        content: header.textContent,
+        url,
+        url_without_variables: url,
+        url_without_anchor: url,
+        ...defaultIndexData,
+      })
+    })
+
+    // find and index tag and operations
+    const baseSpecs = (await OpenAPIParser.parse(
+      path.join(process.cwd(), `specs/${area}/openapi.yaml`)
+    )) as ExpandedDocument
+
+    await Promise.all(
+      baseSpecs.tags?.map(async (tag) => {
+        const tagName = getSectionId([tag.name])
+        const url = getUrl(area, tagName)
+        indices.push({
+          objectID: getObjectId(area, tagName),
+          hierarchy: getHierarchy(area, [tag.name]),
+          type: "lvl1",
+          content: null,
+          url,
+          url_without_variables: url,
+          url_without_anchor: url,
+          ...defaultIndexData,
+        })
+        const paths = await getPathsOfTag(tagName, area)
+
+        Object.values(paths.paths).forEach((path) => {
+          Object.values(path).forEach((op) => {
+            const operation = op as Operation
+            const operationName = getSectionId([
+              tag.name,
+              operation.operationId,
+            ])
+            const url = getUrl(area, operationName)
+            indices.push({
+              objectID: getObjectId(area, operationName),
+              hierarchy: getHierarchy(area, [tag.name, operation.summary]),
+              type: "content",
+              content: operation.summary,
+              content_camel: operation.summary,
+              url,
+              url_without_variables: url,
+              url_without_anchor: url,
+              ...defaultIndexData,
+            })
+
+            // index its description
+            const operationDescriptionId = getSectionId([
+              tag.name,
+              operation.operationId,
+              operation.description.substring(
+                0,
+                Math.min(20, operation.description.length)
+              ),
+            ])
+
+            indices.push({
+              objectID: getObjectId(area, operationDescriptionId),
+              hierarchy: getHierarchy(area, [
+                tag.name,
+                operation.summary,
+                operation.description,
+              ]),
+              type: "content",
+              content: operation.description,
+              content_camel: operation.description,
+              url,
+              url_without_variables: url,
+              url_without_anchor: url,
+              ...defaultIndexData,
+            })
+          })
+        })
+      }) || []
+    )
+  }
+
+  if (indices.length) {
+    await index.saveObjects(indices, {
+      autoGenerateObjectIDIfNotExist: true,
+    })
+  }
+
+  return NextResponse.json({
+    message: "done",
+  })
+}
+
+function getObjectId(area: string, objectName: string): string {
+  return `${area}_${objectName}`
+}
+
+function getHierarchy(area: string, levels: string[]): Record<string, string> {
+  const heirarchy: Record<string, string> = {
+    lvl0: `${capitalize(area)} API Reference`,
+  }
+
+  let counter = 1
+  levels.forEach((level) => {
+    heirarchy[`lvl${counter}`] = level
+    counter++
+  })
+
+  return heirarchy
+}