Initial plugin refactor (#86)

* update openapi types

* start refactoring parser

Author: bourdakos1

jest.config.js

@@ -0,0 +1,16 @@
+/* ============================================================================
+ * Copyright (c) Cloud Annotations
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  roots: [
+    "<rootDir>/packages/docusaurus-plugin-openapi/src",
+    "<rootDir>/packages/docusaurus-preset-openapi/src",
+    "<rootDir>/packages/docusaurus-theme-openapi/src",
+  ],
+};

packages/docusaurus-plugin-openapi/src/markdown/createParamsTable.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ApiItem, ExampleObject, ParameterObject } from "../types";
+import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createFullWidthTable } from "./createFullWidthTable";
 import { getSchemaName } from "./schema";
@@ -20,9 +20,7 @@ export function createParamsTable({ parameters, type }: Props) {
   if (parameters === undefined) {
     return undefined;
   }
-  const params = parameters.filter(
-    (param: any) => param?.in === type
-  ) as ParameterObject[];
+  const params = parameters.filter((param) => param?.in === type);
   if (params.length === 0) {
     return undefined;
   }
@@ -79,9 +77,7 @@ export function createParamsTable({ parameters, type }: Props) {
                     style: { marginTop: "var(--ifm-table-cell-padding)" },
                     children: Object.entries(examples).map(([k, v]) =>
                       create("div", {
-                        children: `Example (${k}): ${
-                          (v as ExampleObject).value
-                        }`,
+                        children: `Example (${k}): ${v.value}`,
                       })
                     ),
                   })

packages/docusaurus-plugin-openapi/src/markdown/createSchemaTable.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { Map, MediaTypeObject, SchemaObject } from "../types";
+import { MediaTypeObject, SchemaObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { createFullWidthTable } from "./createFullWidthTable";
 import { getSchemaName } from "./schema";
@@ -64,11 +64,13 @@ function createRows({ schema }: RowsProps): string | undefined {
         marginBottom: "0px",
       },
       children: create("tbody", {
-        children: Object.keys(schema.properties).map((key) =>
+        children: Object.entries(schema.properties).map(([key, val]) =>
           createRow({
             name: key,
-            schema: schema.properties[key],
-            required: schema.required?.includes(key),
+            schema: val,
+            required: Array.isArray(schema.required)
+              ? schema.required.includes(key)
+              : false,
           })
         ),
       }),
@@ -91,11 +93,13 @@ interface RowsRootProps {
 function createRowsRoot({ schema }: RowsRootProps) {
   // object
   if (schema.properties !== undefined) {
-    return Object.keys(schema.properties).map((key) =>
+    return Object.entries(schema.properties).map(([key, val]) =>
       createRow({
         name: key,
-        schema: schema.properties[key],
-        required: schema.required?.includes(key),
+        schema: val,
+        required: Array.isArray(schema.required)
+          ? schema.required.includes(key)
+          : false,
       })
     );
   }
@@ -128,7 +132,9 @@ interface Props {
   style?: any;
   title: string;
   body: {
-    content: Map<MediaTypeObject>;
+    content: {
+      [key: string]: MediaTypeObject;
+    };
     description?: string;
     required?: boolean;
   };
@@ -144,7 +150,11 @@ export function createSchemaTable({ title, body, ...rest }: Props) {
 
   const randomFirstKey = Object.keys(body.content)[0];
 
-  const firstBody = body.content[randomFirstKey].schema as SchemaObject;
+  const firstBody = body.content[randomFirstKey].schema;
+
+  if (firstBody === undefined) {
+    return undefined;
+  }
 
   // we don't show the table if there is no properties to show
   if (Object.keys(firstBody.properties ?? {}).length === 0) {