feat(samples): add support for custom formats, encoders and media typ…

…es (#8905)

This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577

src/core/plugins/json-schema-2020-12/index.js

@@ -50,7 +50,10 @@ import {
   createXMLExample,
   memoizedSampleFromSchema,
   memoizedCreateXMLExample,
-} from "./samples-extensions/fn"
+  encoderAPI,
+  mediaTypeAPI,
+  formatAPI,
+} from "./samples-extensions/fn/index"
 import { JSONSchemaDeepExpansionContext } from "./context"
 import { useFn, useConfig, useComponent, useIsExpandedDeeply } from "./hooks"
 import { withJSONSchemaContext } from "./hoc"
@@ -113,6 +116,9 @@ const JSONSchema202012Plugin = () => ({
       useIsExpandedDeeply,
       sampleFromSchema,
       sampleFromSchemaGeneric,
+      sampleEncoderAPI: encoderAPI,
+      sampleFormatAPI: formatAPI,
+      sampleMediaTypeAPI: mediaTypeAPI,
       createXMLExample,
       memoizedSampleFromSchema,
       memoizedCreateXMLExample,

src/core/plugins/json-schema-2020-12/samples-extensions/fn/api/encoderAPI.js

@@ -0,0 +1,20 @@
+/**
+ * @prettier
+ */
+
+import EncoderRegistry from "core/plugins/json-schema-2020-12/samples-extensions/fn/class/EncoderRegistry"
+
+const registry = new EncoderRegistry()
+
+const encoderAPI = (encodingName, encoder) => {
+  if (typeof encoder === "function") {
+    return registry.register(encodingName, encoder)
+  } else if (encoder === null) {
+    return registry.unregister(encodingName)
+  }
+
+  return registry.get(encodingName)
+}
+encoderAPI.getDefaults = () => registry.defaults
+
+export default encoderAPI

src/core/plugins/json-schema-2020-12/samples-extensions/fn/api/formatAPI.js

@@ -0,0 +1,19 @@
+/**
+ * @prettier
+ */
+
+import Registry from "../class/Registry"
+
+const registry = new Registry()
+
+const formatAPI = (format, generator) => {
+  if (typeof generator === "function") {
+    return registry.register(format, generator)
+  } else if (generator === null) {
+    return registry.unregister(format)
+  }
+
+  return registry.get(format)
+}
+
+export default formatAPI

src/core/plugins/json-schema-2020-12/samples-extensions/fn/api/mediaTypeAPI.js

@@ -0,0 +1,27 @@
+/**
+ * @prettier
+ */
+
+import MediaTypeRegistry from "../class/MediaTypeRegistry"
+
+const registry = new MediaTypeRegistry()
+
+const mediaTypeAPI = (mediaType, generator) => {
+  if (typeof generator === "function") {
+    return registry.register(mediaType, generator)
+  } else if (generator === null) {
+    return registry.unregister(mediaType)
+  }
+
+  const mediaTypeNoParams = mediaType.split(";").at(0)
+  const topLevelMediaType = `${mediaTypeNoParams.split("/").at(0)}/*`
+
+  return (
+    registry.get(mediaType) ||
+    registry.get(mediaTypeNoParams) ||
+    registry.get(topLevelMediaType)
+  )
+}
+mediaTypeAPI.getDefaults = () => registry.defaults
+
+export default mediaTypeAPI

src/core/plugins/json-schema-2020-12/samples-extensions/fn/class/EncoderRegistry.js

@@ -0,0 +1,31 @@
+/**
+ * @prettier
+ */
+import Registry from "./Registry"
+import encode7bit from "../encoders/7bit"
+import encode8bit from "../encoders/8bit"
+import encodeBinary from "../encoders/binary"
+import encodeQuotedPrintable from "../encoders/quoted-printable"
+import encodeBase16 from "../encoders/base16"
+import encodeBase32 from "../encoders/base32"
+import encodeBase64 from "../encoders/base64"
+
+class EncoderRegistry extends Registry {
+  #defaults = {
+    "7bit": encode7bit,
+    "8bit": encode8bit,
+    binary: encodeBinary,
+    "quoted-printable": encodeQuotedPrintable,
+    base16: encodeBase16,
+    base32: encodeBase32,
+    base64: encodeBase64,
+  }
+
+  data = { ...this.#defaults }
+
+  get defaults() {
+    return { ...this.#defaults }
+  }
+}
+
+export default EncoderRegistry

src/core/plugins/json-schema-2020-12/samples-extensions/fn/class/MediaTypeRegistry.js

@@ -0,0 +1,27 @@
+/**
+ * @prettier
+ */
+import Registry from "./Registry"
+import textMediaTypesGenerators from "../generators/media-types/text"
+import imageMediaTypesGenerators from "../generators/media-types/image"
+import audioMediaTypesGenerators from "../generators/media-types/audio"
+import videoMediaTypesGenerators from "../generators/media-types/video"
+import applicationMediaTypesGenerators from "../generators/media-types/application"
+
+class MediaTypeRegistry extends Registry {
+  #defaults = {
+    ...textMediaTypesGenerators,
+    ...imageMediaTypesGenerators,
+    ...audioMediaTypesGenerators,
+    ...videoMediaTypesGenerators,
+    ...applicationMediaTypesGenerators,
+  }
+
+  data = { ...this.#defaults }
+
+  get defaults() {
+    return { ...this.#defaults }
+  }
+}
+
+export default MediaTypeRegistry

src/core/plugins/json-schema-2020-12/samples-extensions/fn/class/Registry.js

@@ -0,0 +1,24 @@
+/**
+ * @prettier
+ */
+class Registry {
+  data = {}
+
+  register(name, value) {
+    this.data[name] = value
+  }
+
+  unregister(name) {
+    if (typeof name === "undefined") {
+      this.data = {}
+    } else {
+      delete this.data[name]
+    }
+  }
+
+  get(name) {
+    return this.data[name]
+  }
+}
+
+export default Registry

src/core/plugins/json-schema-2020-12/samples-extensions/fn/core/random.js

@@ -0,0 +1,22 @@
+/**
+ * @prettier
+ */
+import randomBytes from "randombytes"
+import RandExp from "randexp"
+export const bytes = (length) => randomBytes(length)
+
+export const randexp = (pattern) => {
+  try {
+    const randexpInstance = new RandExp(pattern)
+    return randexpInstance.gen()
+  } catch {
+    // invalid regex should not cause a crash (regex syntax varies across languages)
+    return "string"
+  }
+}
+
+export const string = () => "string"
+
+export const number = () => 0
+
+export const integer = () => 0

src/core/plugins/json-schema-2020-12/samples-extensions/fn/core/utils.js

@@ -0,0 +1,10 @@
+/**
+ * @prettier
+ */
+export const isURI = (uri) => {
+  try {
+    return new URL(uri) && true
+  } catch {
+    return false
+  }
+}

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/7bit.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const encode7bit = (content) => Buffer.from(content).toString("ascii")
+
+export default encode7bit

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/8bit.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const encode8bit = (content) => Buffer.from(content).toString("utf8")
+
+export default encode8bit

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/base16.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const encodeBase16 = (content) => Buffer.from(content).toString("hex")
+
+export default encodeBase16

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/base32.js

@@ -0,0 +1,34 @@
+/**
+ * @prettier
+ */
+const encodeBase32 = (content) => {
+  const utf8Value = Buffer.from(content).toString("utf8")
+  const base32Alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"
+  let paddingCount = 0
+  let base32Str = ""
+  let buffer = 0
+  let bufferLength = 0
+
+  for (let i = 0; i < utf8Value.length; i++) {
+    buffer = (buffer << 8) | utf8Value.charCodeAt(i)
+    bufferLength += 8
+
+    while (bufferLength >= 5) {
+      base32Str += base32Alphabet.charAt((buffer >>> (bufferLength - 5)) & 31)
+      bufferLength -= 5
+    }
+  }
+
+  if (bufferLength > 0) {
+    base32Str += base32Alphabet.charAt((buffer << (5 - bufferLength)) & 31)
+    paddingCount = (8 - ((utf8Value.length * 8) % 5)) % 5
+  }
+
+  for (let i = 0; i < paddingCount; i++) {
+    base32Str += "="
+  }
+
+  return base32Str
+}
+
+export default encodeBase32

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/base64.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const encodeBase64 = (content) => Buffer.from(content).toString("base64")
+
+export default encodeBase64

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/binary.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const encodeBinary = (content) => Buffer.from(content).toString("binary")
+
+export default encodeBinary

src/core/plugins/json-schema-2020-12/samples-extensions/fn/encoders/quoted-printable.js

@@ -0,0 +1,38 @@
+/**
+ * @prettier
+ */
+const encodeQuotedPrintable = (content) => {
+  let quotedPrintable = ""
+
+  for (let i = 0; i < content.length; i++) {
+    const charCode = content.charCodeAt(i)
+
+    if (charCode === 61) {
+      // ASCII content of "="
+      quotedPrintable += "=3D"
+    } else if (
+      (charCode >= 33 && charCode <= 60) ||
+      (charCode >= 62 && charCode <= 126) ||
+      charCode === 9 ||
+      charCode === 32
+    ) {
+      quotedPrintable += content.charAt(i)
+    } else if (charCode === 13 || charCode === 10) {
+      quotedPrintable += "\r\n"
+    } else if (charCode > 126) {
+      // convert non-ASCII characters to UTF-8 and encode each byte
+      const utf8 = unescape(encodeURIComponent(content.charAt(i)))
+      for (let j = 0; j < utf8.length; j++) {
+        quotedPrintable +=
+          "=" + ("0" + utf8.charCodeAt(j).toString(16)).slice(-2).toUpperCase()
+      }
+    } else {
+      quotedPrintable +=
+        "=" + ("0" + charCode.toString(16)).slice(-2).toUpperCase()
+    }
+  }
+
+  return quotedPrintable
+}
+
+export default encodeQuotedPrintable

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/date-time.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const dateTimeGenerator = () => new Date().toISOString()
+
+export default dateTimeGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/date.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const dateGenerator = () => new Date().toISOString().substring(0, 10)
+
+export default dateGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/double.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const doubleGenerator = () => 0.1
+
+export default doubleGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/duration.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const durationGenerator = () => "P3D" // expresses a duration of 3 days
+
+export default durationGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/email.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const emailGenerator = () => "[email protected]"
+
+export default emailGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/float.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const floatGenerator = () => 0.1
+
+export default floatGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/hostname.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const hostnameGenerator = () => "example.com"
+
+export default hostnameGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/idn-email.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const idnEmailGenerator = () => "실례@example.com"
+
+export default idnEmailGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/idn-hostname.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const idnHostnameGenerator = () => "실례.com"
+
+export default idnHostnameGenerator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/int32.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const int32Generator = () => (2 ** 30) >>> 0
+
+export default int32Generator

src/core/plugins/json-schema-2020-12/samples-extensions/fn/generators/int64.js

@@ -0,0 +1,6 @@
+/**
+ * @prettier
+ */
+const int64Generator = () => 2 ** 53 - 1
+
+export default int64Generator