Merge pull request #398 from jy95/fix-empty

fix: tab crash with empty examples array
jy95 · Jul 10, 2024 · ed39bdc · ed39bdc
2 parents 01b8f70 + d55481f
commit ed39bdc
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 13 deletions.
diff --git a/__tests__/JSONSchemaViewer/constructor.test.tsx b/__tests__/JSONSchemaViewer/constructor.test.tsx
@@ -194,10 +194,7 @@ describe("JSONSchemaViewer - constructor", () => {
     let root: ReactTestRenderer | undefined
     await act(async () => {
       root = create(
-        <JSONSchemaViewer
-          schema={fakeSchema}
-          className="jsv-custom"
-        />,
+        <JSONSchemaViewer schema={fakeSchema} className="jsv-custom" />,
       )
     })
 

diff --git a/src/theme/JSONSchemaViewer/index.tsx b/src/theme/JSONSchemaViewer/index.tsx
@@ -32,7 +32,7 @@ export type Props = {
   /**
    * To customize the styles of the viewer, to override docusaurus styles on a specific page
    */
-  className?: string;
+  className?: string
 }
 
 type InnerViewerProperties = {
@@ -43,7 +43,7 @@ type InnerViewerProperties = {
   // Options for viewer
   viewerOptions?: Omit<JSVOptions, "fullSchema">
   // To customize the styles of the viewer, to override docusaurus styles on a specific page
-  className?: string;
+  className?: string
 }
 
 // Translated labels
@@ -85,7 +85,7 @@ function JSONSchemaInnerViewer(props: InnerViewerProperties): JSX.Element {
           summary={<strong>{title}</strong>}
           detailsProps={{
             open: true,
-            className: props.className || "json-schema-viewer"
+            className: props.className || "json-schema-viewer",
           }}
         >
           <CreateNodes schema={schema} />

diff --git a/src/theme/JSONSchemaViewer/utils/QualifierMessages/QualifierMessagesMap.tsx b/src/theme/JSONSchemaViewer/utils/QualifierMessages/QualifierMessagesMap.tsx
@@ -1,10 +1,10 @@
 import React from "react"
 
 import * as QMS from "@theme/JSONSchemaViewer/utils/QualifierMessages"
+import { hasUnresolvedRefs, isArrayNotEmpty } from "../detectTypes"
 
 import type { JSONSchema, JSONSchemaNS } from "@theme/JSONSchemaViewer/types"
 import type { JSVOptions } from "@theme/JSONSchemaViewer/contexts"
-import { hasUnresolvedRefs } from "../detectTypes"
 
 type Props = {
   schema: Exclude<JSONSchema, true | false>
@@ -64,7 +64,7 @@ const CHECKS_MAP: Record<CheckKey, CheckInfo> = {
     Component: () => <QMS.WriteOnlyQM key={"writeOnly"} />,
   },
   enum: {
-    match: ({ schema }) => schema.enum !== undefined,
+    match: ({ schema }) => isArrayNotEmpty(schema.enum),
     Component: ({ schema }) => <QMS.EnumQM key={"enum"} schema={schema} />,
   },
   stringLength: {
@@ -148,7 +148,7 @@ const CHECKS_MAP: Record<CheckKey, CheckInfo> = {
   },
   examples: {
     match: ({ schema, options }) =>
-      options.showExamples === true && schema.examples !== undefined,
+      options.showExamples === true && isArrayNotEmpty(schema.examples),
     Component: ({ schema }) => (
       <QMS.ExamplesQM key={"examples"} schema={schema} />
     ),

diff --git a/src/theme/JSONSchemaViewer/utils/detectTypes.ts b/src/theme/JSONSchemaViewer/utils/detectTypes.ts
@@ -149,3 +149,7 @@ export function detectedTypes(
   // If array is empty, it could mean that it is either "any" or "nothing"
   return [...foundUndeclaredTypes(schema)]
 }
+
+// Not empty array ?
+export const isArrayNotEmpty = (arr: any[] | readonly any[] | undefined) =>
+  arr !== undefined && arr.length > 0
diff --git a/testsite/docusaurus.config.js b/testsite/docusaurus.config.js
@@ -18,9 +18,9 @@ module.exports = {
   projectName: "docusaurus-json-schema-plugin", // Usually your repo name.
   themeConfig: {
     algolia: {
-      appId: 'IQ028YCDJT',
-      apiKey: '8bd1d98fae984449f5cc44eed58ddb2d',
-      indexName: "jy95io"
+      appId: "IQ028YCDJT",
+      apiKey: "8bd1d98fae984449f5cc44eed58ddb2d",
+      indexName: "jy95io",
     },
     navbar: {
       title: "JSON Schema viewer / editor",