docs: prep for v2 documentation (#6710)

This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
@@ -0,0 +1,59 @@
+import { ApiTestingOptions } from "types"
+
+export type useRequestRunnerProps = {
+  pushLog: (...message: string[]) => void
+  onFinish: (message: string) => void
+  replaceLog?: (message: string) => void
+}
+
+export const useRequestRunner = ({
+  pushLog,
+  onFinish,
+  replaceLog,
+}: useRequestRunnerProps) => {
+  const runRequest = (apiRequestOptions: ApiTestingOptions) => {
+    let requestUrl = apiRequestOptions.url
+    if (apiRequestOptions.pathData) {
+      Object.entries(apiRequestOptions.pathData).forEach(([key, value]) => {
+        if (typeof value === "string") {
+          requestUrl = requestUrl.replace(`{${key}}`, value)
+        }
+      })
+    }
+
+    // check if there are query params
+    if (apiRequestOptions.queryData) {
+      requestUrl += `?${new URLSearchParams(
+        apiRequestOptions.queryData as Record<string, string>
+      ).toString()}`
+    }
+
+    fetch(requestUrl, {
+      method: apiRequestOptions.method,
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: apiRequestOptions.bodyData
+        ? JSON.stringify(apiRequestOptions.bodyData)
+        : undefined,
+    })
+      .then(async (response) => response.json())
+      .then((data) => {
+        const stringifiedData = JSON.stringify(data, undefined, 2)
+        replaceLog ? replaceLog(stringifiedData) : pushLog(stringifiedData)
+      })
+      .catch((error) => {
+        pushLog(
+          `An error ocurred: ${JSON.stringify(error, undefined, 2)}`,
+          `\nThis could be a CORS error. You can resolve it by adding\nthe docs' URLto your CORS configurations:\n`,
+          `STORE_CORS=http://localhost:8000,https://docs.medusajs.com`,
+          `ADMIN_CORS=http://localhost:7001,https://docs.medusajs.com`
+        )
+      })
+      .finally(() => onFinish(`Finished running request.`))
+  }
+
+  return {
+    runRequest,
+  }
+}