From a9dc6b0b051096cbb2f97b8bcd431b44d7886977 Mon Sep 17 00:00:00 2001 From: Vladimir Gorej Date: Mon, 24 Apr 2023 15:10:55 +0200 Subject: [PATCH] feat(json-schema-2020-12): add support for patternProperties keyword Refs #8513 --- .../components/JSONSchema/JSONSchema.jsx | 6 ++- .../PatternProperties/PatternProperties.jsx | 38 +++++++++++++++++++ .../_pattern-properties.scss | 19 ++++++++++ .../keywords/Properties/Properties.jsx | 16 ++++---- .../keywords/Properties/_properties.scss | 9 +++-- .../components/keywords/_all.scss | 1 + src/core/plugins/json-schema-2020-12/fn.js | 5 ++- src/core/plugins/json-schema-2020-12/hoc.jsx | 2 + src/core/plugins/json-schema-2020-12/index.js | 4 +- .../plugins/oas31/wrap-components/models.jsx | 4 ++ 10 files changed, 90 insertions(+), 14 deletions(-) create mode 100644 src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/PatternProperties.jsx create mode 100644 src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/_pattern-properties.scss diff --git a/src/core/plugins/json-schema-2020-12/components/JSONSchema/JSONSchema.jsx b/src/core/plugins/json-schema-2020-12/components/JSONSchema/JSONSchema.jsx index 2567a188..f0ce9564 100644 --- a/src/core/plugins/json-schema-2020-12/components/JSONSchema/JSONSchema.jsx +++ b/src/core/plugins/json-schema-2020-12/components/JSONSchema/JSONSchema.jsx @@ -53,6 +53,7 @@ const JSONSchema = ({ schema, name }) => { const KeywordItems = useComponent("KeywordItems") const KeywordContains = useComponent("KeywordContains") const KeywordProperties = useComponent("KeywordProperties") + const KeywordPatternProperties = useComponent("KeywordPatternProperties") const KeywordType = useComponent("KeywordType") const KeywordFormat = useComponent("KeywordFormat") const KeywordTitle = useComponent("KeywordTitle") @@ -114,7 +115,10 @@ const JSONSchema = ({ schema, name }) => {
{!isCircular && isExpandable && ( - + <> + + + )} diff --git a/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/PatternProperties.jsx b/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/PatternProperties.jsx new file mode 100644 index 00000000..6b91b6dd --- /dev/null +++ b/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/PatternProperties.jsx @@ -0,0 +1,38 @@ +/** + * @prettier + */ +import React from "react" + +import { schema } from "../../../prop-types" +import { useComponent } from "../../../hooks" + +const PatternProperties = ({ schema }) => { + const patternProperties = schema?.patternProperties || {} + + if (Object.keys(patternProperties).length === 0) { + return null + } + + const JSONSchema = useComponent("JSONSchema") + + return ( +
+
    + {Object.entries(patternProperties).map(([propertyName, schema]) => ( +
  • + +
    • + ))} +
+
+ ) +} + +PatternProperties.propTypes = { + schema: schema.isRequired, +} + +export default PatternProperties diff --git a/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/_pattern-properties.scss b/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/_pattern-properties.scss new file mode 100644 index 00000000..2bbfd6a8 --- /dev/null +++ b/src/core/plugins/json-schema-2020-12/components/keywords/PatternProperties/_pattern-properties.scss @@ -0,0 +1,19 @@ +.json-schema-2020-12 { + &-keyword--patternProperties { + ul { + margin: 0; + padding: 0; + border: none; + } + + .json-schema-2020-12__title:first-of-type::before { + color: $prop-type-font-color; + content: "/"; + } + + .json-schema-2020-12__title:first-of-type::after { + color: $prop-type-font-color; + content: "/"; + } + } +} diff --git a/src/core/plugins/json-schema-2020-12/components/keywords/Properties/Properties.jsx b/src/core/plugins/json-schema-2020-12/components/keywords/Properties/Properties.jsx index 4e2bfa88..938ec07a 100644 --- a/src/core/plugins/json-schema-2020-12/components/keywords/Properties/Properties.jsx +++ b/src/core/plugins/json-schema-2020-12/components/keywords/Properties/Properties.jsx @@ -16,13 +16,15 @@ const Properties = ({ schema }) => { const JSONSchema = useComponent("JSONSchema") return ( -
    - {Object.entries(properties).map(([propertyName, schema]) => ( -
  • - -
    • - ))} -
+
+
    + {Object.entries(properties).map(([propertyName, schema]) => ( +
  • + +
    • + ))} +
+
) } diff --git a/src/core/plugins/json-schema-2020-12/components/keywords/Properties/_properties.scss b/src/core/plugins/json-schema-2020-12/components/keywords/Properties/_properties.scss index aa7718d7..a89f54f9 100644 --- a/src/core/plugins/json-schema-2020-12/components/keywords/Properties/_properties.scss +++ b/src/core/plugins/json-schema-2020-12/components/keywords/Properties/_properties.scss @@ -1,7 +1,10 @@ .json-schema-2020-12 { - &__properties { - margin: 0; - padding: 0; + &-keyword--properties { + ul { + margin: 0; + padding: 0; + border: none; + } } &-property { diff --git a/src/core/plugins/json-schema-2020-12/components/keywords/_all.scss b/src/core/plugins/json-schema-2020-12/components/keywords/_all.scss index f90fa61f..0fecfab8 100644 --- a/src/core/plugins/json-schema-2020-12/components/keywords/_all.scss +++ b/src/core/plugins/json-schema-2020-12/components/keywords/_all.scss @@ -49,3 +49,4 @@ @import './Description/description'; @import './Title/title'; @import './Properties/properties'; +@import './PatternProperties/pattern-properties'; diff --git a/src/core/plugins/json-schema-2020-12/fn.js b/src/core/plugins/json-schema-2020-12/fn.js index 8e645ef8..cc20ddf2 100644 --- a/src/core/plugins/json-schema-2020-12/fn.js +++ b/src/core/plugins/json-schema-2020-12/fn.js @@ -144,7 +144,8 @@ export const isExpandable = (schema) => { schema?.prefixItems || schema?.items || schema?.contains || - schema?.description || - schema?.properties + schema?.properties || + schema?.patternProperties || + schema?.description ) } diff --git a/src/core/plugins/json-schema-2020-12/hoc.jsx b/src/core/plugins/json-schema-2020-12/hoc.jsx index a1b94562..69538316 100644 --- a/src/core/plugins/json-schema-2020-12/hoc.jsx +++ b/src/core/plugins/json-schema-2020-12/hoc.jsx @@ -25,6 +25,7 @@ import KeywordPrefixItems from "./components/keywords/PrefixItems" import KeywordItems from "./components/keywords/Items" import KeywordContains from "./components/keywords/Contains" import KeywordProperties from "./components/keywords/Properties/Properties" +import KeywordPatternProperties from "./components/keywords/PatternProperties/PatternProperties" import KeywordType from "./components/keywords/Type/Type" import KeywordFormat from "./components/keywords/Format/Format" import KeywordTitle from "./components/keywords/Title/Title" @@ -66,6 +67,7 @@ export const withJSONSchemaContext = (Component, overrides = {}) => { KeywordItems, KeywordContains, KeywordProperties, + KeywordPatternProperties, KeywordType, KeywordFormat, KeywordTitle, diff --git a/src/core/plugins/json-schema-2020-12/index.js b/src/core/plugins/json-schema-2020-12/index.js index 30169f4a..e90d353c 100644 --- a/src/core/plugins/json-schema-2020-12/index.js +++ b/src/core/plugins/json-schema-2020-12/index.js @@ -2,7 +2,6 @@ * @prettier */ import JSONSchema from "./components/JSONSchema/JSONSchema" -import KeywordProperties from "./components/keywords/Properties/Properties" import Keyword$schema from "./components/keywords/$schema" import Keyword$vocabulary from "./components/keywords/$vocabulary/$vocabulary" import Keyword$id from "./components/keywords/$id" @@ -23,6 +22,8 @@ import KeywordDependentSchemas from "./components/keywords/DependentSchemas" import KeywordPrefixItems from "./components/keywords/PrefixItems" import KeywordItems from "./components/keywords/Items" import KeywordContains from "./components/keywords/Contains" +import KeywordProperties from "./components/keywords/Properties/Properties" +import KeywordPatternProperties from "./components/keywords/PatternProperties/PatternProperties" import KeywordType from "./components/keywords/Type/Type" import KeywordFormat from "./components/keywords/Format/Format" import KeywordTitle from "./components/keywords/Title/Title" @@ -57,6 +58,7 @@ const JSONSchema202012Plugin = () => ({ JSONSchema202012KeywordItems: KeywordItems, JSONSchema202012KeywordContains: KeywordContains, JSONSchema202012KeywordProperties: KeywordProperties, + JSONSchema202012KeywordPatternProperties: KeywordPatternProperties, JSONSchema202012KeywordType: KeywordType, JSONSchema202012KeywordFormat: KeywordFormat, JSONSchema202012KeywordTitle: KeywordTitle, diff --git a/src/core/plugins/oas31/wrap-components/models.jsx b/src/core/plugins/oas31/wrap-components/models.jsx index b00f20e1..feba29b4 100644 --- a/src/core/plugins/oas31/wrap-components/models.jsx +++ b/src/core/plugins/oas31/wrap-components/models.jsx @@ -34,6 +34,9 @@ const ModelsWrapper = createOnlyOAS31ComponentWrapper(({ getSystem }) => { const KeywordItems = getComponent("JSONSchema202012KeywordItems") const KeywordContains = getComponent("JSONSchema202012KeywordContains") const KeywordProperties = getComponent("JSONSchema202012KeywordProperties") + const KeywordPatternProperties = getComponent( + "JSONSchema202012KeywordPatternProperties" + ) const KeywordType = getComponent("JSONSchema202012KeywordType") const KeywordFormat = getComponent("JSONSchema202012KeywordFormat") const KeywordTitle = getComponent("JSONSchema202012KeywordTitle") @@ -73,6 +76,7 @@ const ModelsWrapper = createOnlyOAS31ComponentWrapper(({ getSystem }) => { KeywordItems, KeywordContains, KeywordProperties, + KeywordPatternProperties, KeywordType, KeywordFormat, KeywordTitle,