@scalar/api-reference 1.38.0 → 1.39.0

package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js

@@ -1,235 +1,330 @@
-import { defineComponent as P, toRef as A, computed as s, createElementBlock as u, openBlock as a, createCommentVNode as l, createBlock as m, normalizeClass as I, renderSlot as L, Fragment as p, withCtx as n, createVNode as c, createTextVNode as i, toDisplayString as v, renderList as R, createSlots as T, unref as k } from "vue";
-import { isDefined as f } from "@scalar/helpers/array/is-defined";
-import { getResolvedRef as S } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { isArraySchema as h, isStringSchema as N, isNumberSchema as B } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
-import _ from "../../ScreenReader.vue.js";
-import { getSchemaType as V } from "./helpers/get-schema-type.js";
-import { getModelName as $ } from "./helpers/schema-name.js";
-import b from "./RenderString.vue.js";
-import d from "./SchemaPropertyDetail.vue.js";
-import C from "./SchemaPropertyExamples.vue.js";
-import E from "../../Badge/Badge.vue.js";
-const J = { class: "property-heading" }, F = {
+import { defineComponent, toRef, computed, createElementBlock, openBlock, createCommentVNode, createBlock, normalizeClass, renderSlot, Fragment, withCtx, createVNode, createTextVNode, toDisplayString, renderList, createSlots, unref } from "vue";
+import { isDefined } from "@scalar/helpers/array/is-defined";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { isArraySchema, isStringSchema, isNumberSchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
+import ScreenReader from "../../ScreenReader.vue.js";
+import { getSchemaType } from "./helpers/get-schema-type.js";
+import { getModelName } from "./helpers/schema-name.js";
+import _sfc_main$1 from "./RenderString.vue.js";
+import SchemaPropertyDetail from "./SchemaPropertyDetail.vue.js";
+import SchemaPropertyExamples from "./SchemaPropertyExamples.vue.js";
+import Badge from "../../Badge/Badge.vue.js";
+const _hoisted_1 = { class: "property-heading" };
+const _hoisted_2 = {
   key: 1,
   class: "property-discriminator"
-}, j = {
+};
+const _hoisted_3 = {
   key: 3,
   class: "property-additional"
-}, z = {
+};
+const _hoisted_4 = {
   key: 4,
   class: "property-deprecated"
-}, H = {
+};
+const _hoisted_5 = {
   key: 5,
   class: "property-const"
-}, G = {
+};
+const _hoisted_6 = {
   key: 7,
   class: "property-write-only"
-}, K = {
+};
+const _hoisted_7 = {
   key: 8,
   class: "property-read-only"
-}, Q = {
+};
+const _hoisted_8 = {
   key: 9,
   class: "property-required"
-}, le = /* @__PURE__ */ P({
+};
+const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "SchemaPropertyHeading",
   props: {
     value: {},
     enum: { type: Boolean },
-    isDiscriminator: { type: Boolean, default: !1 },
-    required: { type: Boolean, default: !1 },
+    isDiscriminator: { type: Boolean, default: false },
+    required: { type: Boolean, default: false },
     additional: { type: Boolean },
-    withExamples: { type: Boolean, default: !0 },
-    hideModelNames: { type: Boolean, default: !1 }
+    withExamples: { type: Boolean, default: true },
+    hideModelNames: { type: Boolean, default: false }
   },
-  setup(q) {
-    const r = q, y = A(r, "value"), x = s(() => {
-      if (!y.value)
-        return;
-      const e = y.value;
-      if (e.const !== void 0)
-        return e.const;
-      if (e.enum?.length === 1)
-        return e.enum[0];
-      if (h(e) && e.items) {
-        const t = S(e.items);
-        if (f(t.const))
-          return t.const;
-        if (t.enum?.length === 1)
-          return t.enum[0];
-      }
-    }), w = s(() => {
-      if (!y.value)
+  setup(__props) {
+    const props = __props;
+    const valueRef = toRef(props, "value");
+    const constValue = computed(() => {
+      if (!valueRef.value) {
+        return void 0;
+      }
+      const schema = valueRef.value;
+      if (schema.const !== void 0) {
+        return schema.const;
+      }
+      if (schema.enum?.length === 1) {
+        return schema.enum[0];
+      }
+      if (isArraySchema(schema) && schema.items) {
+        const items = getResolvedRef(schema.items);
+        if (isDefined(items.const)) {
+          return items.const;
+        }
+        if (items.enum?.length === 1) {
+          return items.enum[0];
+        }
+      }
+      return void 0;
+    });
+    const validationProperties = computed(() => {
+      if (!valueRef.value) {
         return [];
-      const e = y.value, t = [];
-      return h(e) && ((e.minItems || e.maxItems) && t.push({
-        key: "array-range",
-        value: `${e.minItems || ""}…${e.maxItems || ""}`
-      }), e.uniqueItems && t.push({
-        key: "unique-items",
-        value: "unique!"
-      })), N(e) && (e.minLength && t.push({
-        key: "min-length",
-        prefix: "min length: ",
-        value: e.minLength
-      }), e.maxLength && t.push({
-        key: "max-length",
-        prefix: "max length: ",
-        value: e.maxLength
-      }), e.pattern && t.push({
-        key: "pattern",
-        value: e.pattern,
-        code: !0,
-        truncate: !0
-      })), (N(e) || B(e)) && e.format && t.push({
-        key: "format",
-        value: e.format,
-        truncate: !0
-      }), B(e) && (f(e.exclusiveMinimum) && t.push({
-        key: "exclusive-minimum",
-        prefix: "greater than: ",
-        value: e.exclusiveMinimum
-      }), f(e.minimum) && t.push({
-        key: "minimum",
-        prefix: "min: ",
-        value: e.minimum
-      }), f(e.exclusiveMaximum) && t.push({
-        key: "exclusive-maximum",
-        prefix: "less than: ",
-        value: e.exclusiveMaximum
-      }), f(e.maximum) && t.push({
-        key: "maximum",
-        prefix: "max: ",
-        value: e.maximum
-      }), f(e.multipleOf) && t.push({
-        key: "multiple-of",
-        prefix: "multiple of: ",
-        value: e.multipleOf
-      })), t;
-    }), D = s(() => r.value ? $(r.value, r.hideModelNames) : null), M = s(() => !r.value || !("type" in r.value) ? !1 : r.value.type === "array" ? !0 : !x.value), O = s(() => r.value ? D.value || V(r.value) : ""), g = s(() => {
-      const e = r.value;
-      return e?.default === null ? "null" : Array.isArray(e?.default) && e?.default.length === 1 ? String(e?.default[0]) : typeof e?.default == "string" ? JSON.stringify(e.default) : Array.isArray(e?.default) || typeof e?.default == "object" ? JSON.stringify(e?.default) : e?.default;
+      }
+      const schema = valueRef.value;
+      const properties = [];
+      if (isArraySchema(schema)) {
+        if (schema.minItems || schema.maxItems) {
+          properties.push({
+            key: "array-range",
+            value: `${schema.minItems || ""}…${schema.maxItems || ""}`
+          });
+        }
+        if (schema.uniqueItems) {
+          properties.push({
+            key: "unique-items",
+            value: "unique!"
+          });
+        }
+      }
+      if (isStringSchema(schema)) {
+        if (schema.minLength) {
+          properties.push({
+            key: "min-length",
+            prefix: "min length: ",
+            value: schema.minLength
+          });
+        }
+        if (schema.maxLength) {
+          properties.push({
+            key: "max-length",
+            prefix: "max length: ",
+            value: schema.maxLength
+          });
+        }
+        if (schema.pattern) {
+          properties.push({
+            key: "pattern",
+            value: schema.pattern,
+            code: true,
+            truncate: true
+          });
+        }
+      }
+      if (isStringSchema(schema) || isNumberSchema(schema)) {
+        if (schema.format) {
+          properties.push({
+            key: "format",
+            value: schema.format,
+            truncate: true
+          });
+        }
+      }
+      if (isNumberSchema(schema)) {
+        if (isDefined(schema.exclusiveMinimum)) {
+          properties.push({
+            key: "exclusive-minimum",
+            prefix: "greater than: ",
+            value: schema.exclusiveMinimum
+          });
+        }
+        if (isDefined(schema.minimum)) {
+          properties.push({
+            key: "minimum",
+            prefix: "min: ",
+            value: schema.minimum
+          });
+        }
+        if (isDefined(schema.exclusiveMaximum)) {
+          properties.push({
+            key: "exclusive-maximum",
+            prefix: "less than: ",
+            value: schema.exclusiveMaximum
+          });
+        }
+        if (isDefined(schema.maximum)) {
+          properties.push({
+            key: "maximum",
+            prefix: "max: ",
+            value: schema.maximum
+          });
+        }
+        if (isDefined(schema.multipleOf)) {
+          properties.push({
+            key: "multiple-of",
+            prefix: "multiple of: ",
+            value: schema.multipleOf
+          });
+        }
+      }
+      return properties;
+    });
+    const modelName = computed(() => {
+      if (!props.value) {
+        return null;
+      }
+      return getModelName(props.value, props.hideModelNames);
+    });
+    const shouldShowType = computed(() => {
+      if (!props.value || !("type" in props.value)) {
+        return false;
+      }
+      if (props.value.type === "array") {
+        return true;
+      }
+      return !constValue.value;
+    });
+    const displayType = computed(() => {
+      if (!props.value) {
+        return "";
+      }
+      return modelName.value || getSchemaType(props.value);
     });
-    return (e, t) => (a(), u("div", J, [
-      e.$slots.name ? (a(), u("div", {
-        key: 0,
-        class: I(["property-name", { deprecated: r.value?.deprecated }])
-      }, [
-        L(e.$slots, "name", {}, void 0, !0)
-      ], 2)) : l("", !0),
-      r.isDiscriminator ? (a(), u("div", F, " Discriminator ")) : l("", !0),
-      r.value ? (a(), u(p, { key: 2 }, [
-        M.value ? (a(), m(d, {
+    const flattenedDefaultValue = computed(() => {
+      const value = props.value;
+      if (value?.default === null) {
+        return "null";
+      }
+      if (Array.isArray(value?.default) && value?.default.length === 1) {
+        return String(value?.default[0]);
+      }
+      if (typeof value?.default === "string") {
+        return JSON.stringify(value.default);
+      }
+      if (Array.isArray(value?.default)) {
+        return JSON.stringify(value?.default);
+      }
+      if (typeof value?.default === "object") {
+        return JSON.stringify(value?.default);
+      }
+      return value?.default;
+    });
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock("div", _hoisted_1, [
+        _ctx.$slots.name ? (openBlock(), createElementBlock("div", {
           key: 0,
-          truncate: ""
-        }, {
-          default: n(() => [
-            c(_, null, {
-              default: n(() => t[0] || (t[0] = [
-                i("Type: ")
-              ])),
-              _: 1,
-              __: [0]
-            }),
-            i(v(O.value), 1)
-          ]),
-          _: 1
-        })) : l("", !0),
-        (a(!0), u(p, null, R(w.value, (o) => (a(), m(d, {
-          key: o.key,
-          code: o.code,
-          truncate: o.truncate
-        }, T({
-          default: n(() => [
-            o.key === "format" ? (a(), m(_, { key: 0 }, {
-              default: n(() => t[1] || (t[1] = [
-                i("Format:")
-              ])),
-              _: 1,
-              __: [1]
-            })) : o.key === "pattern" ? (a(), m(_, { key: 1 }, {
-              default: n(() => t[2] || (t[2] = [
-                i(" Pattern: ")
-              ])),
-              _: 1,
-              __: [2]
-            })) : l("", !0),
-            i(" " + v(o.value), 1)
-          ]),
-          _: 2
+          class: normalizeClass(["property-name", { deprecated: props.value?.deprecated }])
         }, [
-          o.prefix ? {
-            name: "prefix",
-            fn: n(() => [
-              i(v(o.prefix), 1)
+          renderSlot(_ctx.$slots, "name", {}, void 0, true)
+        ], 2)) : createCommentVNode("", true),
+        props.isDiscriminator ? (openBlock(), createElementBlock("div", _hoisted_2, " Discriminator ")) : createCommentVNode("", true),
+        props.value ? (openBlock(), createElementBlock(Fragment, { key: 2 }, [
+          shouldShowType.value ? (openBlock(), createBlock(SchemaPropertyDetail, {
+            key: 0,
+            truncate: ""
+          }, {
+            default: withCtx(() => [
+              createVNode(ScreenReader, null, {
+                default: withCtx(() => [..._cache[0] || (_cache[0] = [
+                  createTextVNode("Type: ", -1)
+                ])]),
+                _: 1
+              }),
+              createTextVNode(toDisplayString(displayType.value), 1)
+            ]),
+            _: 1
+          })) : createCommentVNode("", true),
+          (openBlock(true), createElementBlock(Fragment, null, renderList(validationProperties.value, (property) => {
+            return openBlock(), createBlock(SchemaPropertyDetail, {
+              key: property.key,
+              code: property.code,
+              truncate: property.truncate
+            }, createSlots({
+              default: withCtx(() => [
+                property.key === "format" ? (openBlock(), createBlock(ScreenReader, { key: 0 }, {
+                  default: withCtx(() => [..._cache[1] || (_cache[1] = [
+                    createTextVNode("Format:", -1)
+                  ])]),
+                  _: 1
+                })) : property.key === "pattern" ? (openBlock(), createBlock(ScreenReader, { key: 1 }, {
+                  default: withCtx(() => [..._cache[2] || (_cache[2] = [
+                    createTextVNode(" Pattern: ", -1)
+                  ])]),
+                  _: 1
+                })) : createCommentVNode("", true),
+                createTextVNode(" " + toDisplayString(property.value), 1)
+              ]),
+              _: 2
+            }, [
+              property.prefix ? {
+                name: "prefix",
+                fn: withCtx(() => [
+                  createTextVNode(toDisplayString(property.prefix), 1)
+                ]),
+                key: "0"
+              } : void 0
+            ]), 1032, ["code", "truncate"]);
+          }), 128)),
+          props.enum ? (openBlock(), createBlock(SchemaPropertyDetail, { key: 1 }, {
+            default: withCtx(() => [..._cache[3] || (_cache[3] = [
+              createTextVNode("enum", -1)
+            ])]),
+            _: 1
+          })) : createCommentVNode("", true),
+          flattenedDefaultValue.value !== void 0 ? (openBlock(), createBlock(SchemaPropertyDetail, {
+            key: 2,
+            truncate: ""
+          }, {
+            prefix: withCtx(() => [..._cache[4] || (_cache[4] = [
+              createTextVNode("default:", -1)
+            ])]),
+            default: withCtx(() => [
+              createTextVNode(toDisplayString(flattenedDefaultValue.value), 1)
+            ]),
+            _: 1
+          })) : createCommentVNode("", true)
+        ], 64)) : createCommentVNode("", true),
+        props.additional ? (openBlock(), createElementBlock("div", _hoisted_3, [
+          props.value?.["x-additionalPropertiesName"] ? (openBlock(), createElementBlock(Fragment, { key: 0 }, [
+            createTextVNode(toDisplayString(props.value["x-additionalPropertiesName"]), 1)
+          ], 64)) : (openBlock(), createElementBlock(Fragment, { key: 1 }, [
+            createTextVNode("additional properties")
+          ], 64))
+        ])) : createCommentVNode("", true),
+        props.value?.deprecated ? (openBlock(), createElementBlock("div", _hoisted_4, [
+          createVNode(unref(Badge), null, {
+            default: withCtx(() => [..._cache[5] || (_cache[5] = [
+              createTextVNode("deprecated", -1)
+            ])]),
+            _: 1
+          })
+        ])) : createCommentVNode("", true),
+        constValue.value !== void 0 ? (openBlock(), createElementBlock("div", _hoisted_5, [
+          createVNode(SchemaPropertyDetail, { truncate: "" }, {
+            prefix: withCtx(() => [..._cache[6] || (_cache[6] = [
+              createTextVNode("const: ", -1)
+            ])]),
+            default: withCtx(() => [
+              createVNode(_sfc_main$1, { value: constValue.value }, null, 8, ["value"])
             ]),
-            key: "0"
-          } : void 0
-        ]), 1032, ["code", "truncate"]))), 128)),
-        r.enum ? (a(), m(d, { key: 1 }, {
-          default: n(() => t[3] || (t[3] = [
-            i("enum")
-          ])),
-          _: 1,
-          __: [3]
-        })) : l("", !0),
-        g.value !== void 0 ? (a(), m(d, {
-          key: 2,
-          truncate: ""
-        }, {
-          prefix: n(() => t[4] || (t[4] = [
-            i("default:")
-          ])),
-          default: n(() => [
-            i(v(g.value), 1)
-          ]),
-          _: 1
-        })) : l("", !0)
-      ], 64)) : l("", !0),
-      r.additional ? (a(), u("div", j, [
-        r.value?.["x-additionalPropertiesName"] ? (a(), u(p, { key: 0 }, [
-          i(v(r.value["x-additionalPropertiesName"]), 1)
-        ], 64)) : (a(), u(p, { key: 1 }, [
-          i("additional properties")
-        ], 64))
-      ])) : l("", !0),
-      r.value?.deprecated ? (a(), u("div", z, [
-        c(k(E), null, {
-          default: n(() => t[5] || (t[5] = [
-            i("deprecated")
-          ])),
-          _: 1,
-          __: [5]
-        })
-      ])) : l("", !0),
-      x.value !== void 0 ? (a(), u("div", H, [
-        c(d, { truncate: "" }, {
-          prefix: n(() => t[6] || (t[6] = [
-            i("const: ")
-          ])),
-          default: n(() => [
-            c(b, { value: x.value }, null, 8, ["value"])
-          ]),
-          _: 1
-        })
-      ])) : (a(), u(p, { key: 6 }, [
-        r.value?.nullable === !0 ? (a(), m(d, { key: 0 }, {
-          default: n(() => t[7] || (t[7] = [
-            i(" nullable ")
-          ])),
-          _: 1,
-          __: [7]
-        })) : l("", !0)
-      ], 64)),
-      r.value?.writeOnly ? (a(), u("div", G, " write-only ")) : r.value?.readOnly ? (a(), u("div", K, " read-only ")) : l("", !0),
-      r.required ? (a(), u("div", Q, " required ")) : l("", !0),
-      r.withExamples ? (a(), m(C, {
-        key: 10,
-        example: r.value?.example || r.value && k(h)(r.value) && k(S)(r.value?.items)?.example,
-        examples: r.value?.examples
-      }, null, 8, ["example", "examples"])) : l("", !0)
-    ]));
+            _: 1
+          })
+        ])) : (openBlock(), createElementBlock(Fragment, { key: 6 }, [
+          props.value?.nullable === true ? (openBlock(), createBlock(SchemaPropertyDetail, { key: 0 }, {
+            default: withCtx(() => [..._cache[7] || (_cache[7] = [
+              createTextVNode(" nullable ", -1)
+            ])]),
+            _: 1
+          })) : createCommentVNode("", true)
+        ], 64)),
+        props.value?.writeOnly ? (openBlock(), createElementBlock("div", _hoisted_6, " write-only ")) : props.value?.readOnly ? (openBlock(), createElementBlock("div", _hoisted_7, " read-only ")) : createCommentVNode("", true),
+        props.required ? (openBlock(), createElementBlock("div", _hoisted_8, " required ")) : createCommentVNode("", true),
+        props.withExamples ? (openBlock(), createBlock(SchemaPropertyExamples, {
+          key: 10,
+          example: props.value?.example || props.value && unref(isArraySchema)(props.value) && unref(getResolvedRef)(props.value?.items)?.example,
+          examples: props.value?.examples
+        }, null, 8, ["example", "examples"])) : createCommentVNode("", true)
+      ]);
+    };
   }
 });
 export {
-  le as default
+  _sfc_main as default
 };

package/dist/components/Content/Schema/helpers/format-example.js

@@ -1,6 +1,41 @@
-function t(r) {
-  return Array.isArray(r) ? `[${r.map((n) => typeof n == "string" ? `"${n.toString().trim()}"` : typeof n == "object" ? JSON.stringify(n) : n === void 0 ? "undefined" : n === null ? "null" : n).join(", ")}]` : r === null ? "null" : typeof r == "object" ? "value" in r ? r.value : "externalValue" in r ? r.externalValue : JSON.stringify(r) : r === void 0 ? "undefined" : typeof r == "string" ? r.trim() : r.toString().trim();
+function formatExample(example) {
+  if (Array.isArray(example)) {
+    return `[${example.map((item) => {
+      if (typeof item === "string") {
+        return `"${item.toString().trim()}"`;
+      }
+      if (typeof item === "object") {
+        return JSON.stringify(item);
+      }
+      if (item === void 0) {
+        return "undefined";
+      }
+      if (item === null) {
+        return "null";
+      }
+      return item;
+    }).join(", ")}]`;
+  }
+  if (example === null) {
+    return "null";
+  }
+  if (typeof example === "object") {
+    if ("value" in example) {
+      return example.value;
+    }
+    if ("externalValue" in example) {
+      return example.externalValue;
+    }
+    return JSON.stringify(example);
+  }
+  if (example === void 0) {
+    return "undefined";
+  }
+  if (typeof example === "string") {
+    return example.trim();
+  }
+  return example.toString().trim();
 }
 export {
-  t as formatExample
+  formatExample
 };

package/dist/components/Content/Schema/helpers/get-ref-name.d.ts

@@ -7,5 +7,5 @@ import type { ReferenceType } from '@scalar/workspace-store/schemas/v3.1/strict/
  *
  * @example SchemaName from #/components/schemas/SchemaName
  */
-export declare const getRefName: (schema: ReferenceType<SchemaObject>) => string | null;
+export declare const getRefName: (schema: ReferenceType<SchemaObject>) => string | null | undefined;
 //# sourceMappingURL=get-ref-name.d.ts.map

package/dist/components/Content/Schema/helpers/get-ref-name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-ref-name.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/Schema/helpers/get-ref-name.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAChG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uDAAuD,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,aAAa,CAAC,YAAY,CAAC,kBAiB7D,CAAA"}
+{"version":3,"file":"get-ref-name.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/Schema/helpers/get-ref-name.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAChG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uDAAuD,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,aAAa,CAAC,YAAY,CAAC,8BAiB7D,CAAA"}

package/dist/components/Content/Schema/helpers/get-ref-name.js

@@ -1,13 +1,18 @@
-import { REGEX as e } from "@scalar/helpers/regex/regex-helpers";
-const u = (r) => {
-  if (!("$ref" in r))
+import { REGEX } from "@scalar/helpers/regex/regex-helpers";
+const getRefName = (schema) => {
+  if (!("$ref" in schema)) {
     return null;
-  const t = r.$ref;
-  if (!t)
+  }
+  const ref = schema.$ref;
+  if (!ref) {
     return null;
-  const n = t.match(e.REF_NAME);
-  return n ? n[1] : null;
+  }
+  const match = ref.match(REGEX.REF_NAME);
+  if (match) {
+    return match[1];
+  }
+  return null;
 };
 export {
-  u as getRefName
+  getRefName
 };