@scalar/api-reference 1.48.8 → 1.49.1

package/dist/components/Content/Schema/SchemaPropertyDetail.vue.js

@@ -1,7 +0,0 @@
-import _sfc_main from "./SchemaPropertyDetail.vue2.js";
-/* empty css                          */
-import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
-const SchemaPropertyDetail = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-1295f965"]]);
-export {
-  SchemaPropertyDetail as default
-};

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

@@ -1,40 +0,0 @@
-import { defineComponent, createElementBlock, openBlock, normalizeClass, createCommentVNode, renderSlot, createTextVNode } from "vue";
-const _hoisted_1 = {
-  key: 0,
-  class: "property-detail-prefix"
-};
-const _hoisted_2 = {
-  key: 1,
-  class: "property-detail-value"
-};
-const _hoisted_3 = {
-  key: 2,
-  class: "property-detail-value"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "SchemaPropertyDetail",
-  props: {
-    truncate: { type: Boolean },
-    code: { type: Boolean }
-  },
-  setup(__props) {
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock("span", {
-        class: normalizeClass(["property-detail", { "property-detail-truncate": __props.truncate }])
-      }, [
-        _ctx.$slots.prefix ? (openBlock(), createElementBlock("div", _hoisted_1, [
-          renderSlot(_ctx.$slots, "prefix", {}, void 0, true),
-          _cache[0] || (_cache[0] = createTextVNode("  ", -1))
-        ])) : createCommentVNode("", true),
-        __props.code ? (openBlock(), createElementBlock("code", _hoisted_2, [
-          renderSlot(_ctx.$slots, "default", {}, void 0, true)
-        ])) : (openBlock(), createElementBlock("span", _hoisted_3, [
-          renderSlot(_ctx.$slots, "default", {}, void 0, true)
-        ]))
-      ], 2);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/components/Content/Schema/SchemaPropertyExamples.vue.js

@@ -1,7 +0,0 @@
-import _sfc_main from "./SchemaPropertyExamples.vue2.js";
-/* empty css                            */
-import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
-const SchemaPropertyExamples = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-72def0ea"]]);
-export {
-  SchemaPropertyExamples as default
-};

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

@@ -1,80 +0,0 @@
-import { defineComponent, createElementBlock, openBlock, Fragment, createCommentVNode, createElementVNode, unref, createVNode, toDisplayString, renderList } from "vue";
-import { ScalarIcon } from "@scalar/components";
-import { useClipboard } from "@scalar/use-hooks/useClipboard";
-import { formatExample } from "./helpers/format-example.js";
-const _hoisted_1 = {
-  key: 0,
-  class: "property-example"
-};
-const _hoisted_2 = { class: "property-example-value-list" };
-const _hoisted_3 = {
-  key: 1,
-  class: "property-example"
-};
-const _hoisted_4 = {
-  class: "property-example-label",
-  type: "button"
-};
-const _hoisted_5 = { class: "property-example-value-list" };
-const _hoisted_6 = ["onClick"];
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "SchemaPropertyExamples",
-  props: {
-    examples: {},
-    example: {}
-  },
-  setup(__props) {
-    const { copyToClipboard } = useClipboard();
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock(Fragment, null, [
-        __props.example ? (openBlock(), createElementBlock("div", _hoisted_1, [
-          _cache[1] || (_cache[1] = createElementVNode("button", {
-            class: "property-example-label",
-            type: "button"
-          }, [
-            createElementVNode("span", null, "Example")
-          ], -1)),
-          createElementVNode("div", _hoisted_2, [
-            createElementVNode("button", {
-              class: "property-example-value group",
-              type: "button",
-              onClick: _cache[0] || (_cache[0] = ($event) => unref(copyToClipboard)(unref(formatExample)(__props.example)))
-            }, [
-              createElementVNode("span", null, toDisplayString(unref(formatExample)(__props.example)), 1),
-              createVNode(unref(ScalarIcon), {
-                class: "group-hover:text-c-1 text-c-3 ml-auto min-h-3 min-w-3",
-                icon: "Clipboard",
-                size: "xs"
-              })
-            ])
-          ])
-        ])) : createCommentVNode("", true),
-        __props.examples && typeof __props.examples === "object" && Object.keys(__props.examples).length > 0 ? (openBlock(), createElementBlock("div", _hoisted_3, [
-          createElementVNode("button", _hoisted_4, [
-            createElementVNode("span", null, toDisplayString(Object.keys(__props.examples).length === 1 ? "Example" : "Examples"), 1)
-          ]),
-          createElementVNode("div", _hoisted_5, [
-            (openBlock(true), createElementBlock(Fragment, null, renderList(__props.examples, (ex, key) => {
-              return openBlock(), createElementBlock("button", {
-                key,
-                class: "property-example-value group",
-                type: "button",
-                onClick: ($event) => unref(copyToClipboard)(unref(formatExample)(ex))
-              }, [
-                createElementVNode("span", null, toDisplayString(unref(formatExample)(ex)), 1),
-                createVNode(unref(ScalarIcon), {
-                  class: "text-c-3 group-hover:text-c-1 ml-auto min-h-3 min-w-3",
-                  icon: "Clipboard",
-                  size: "xs"
-                })
-              ], 8, _hoisted_6);
-            }), 128))
-          ])
-        ])) : createCommentVNode("", true)
-      ], 64);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

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

@@ -1,7 +0,0 @@
-import _sfc_main from "./SchemaPropertyHeading.vue2.js";
-/* empty css                           */
-import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
-const SchemaPropertyHeading = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-881aa734"]]);
-export {
-  SchemaPropertyHeading as default
-};

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

@@ -1,318 +0,0 @@
-import { defineComponent, toRef, computed, createElementBlock, openBlock, createCommentVNode, createVNode, createBlock, normalizeClass, renderSlot, Fragment, withCtx, createTextVNode, toDisplayString, renderList, createSlots, unref } from "vue";
-import { isDefined } from "@scalar/helpers/array/is-defined";
-import { resolve } from "@scalar/workspace-store/resolve";
-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 { getModelNameFromSchema } from "./helpers/schema-name.js";
-import _sfc_main$1 from "./RenderString.vue.js";
-import SchemaPropertyDefault from "./SchemaPropertyDefault.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"
-};
-const _hoisted_3 = {
-  key: 3,
-  class: "property-additional"
-};
-const _hoisted_4 = {
-  key: 4,
-  class: "property-deprecated"
-};
-const _hoisted_5 = {
-  key: 5,
-  class: "property-const"
-};
-const _hoisted_6 = {
-  key: 7,
-  class: "property-write-only"
-};
-const _hoisted_7 = {
-  key: 8,
-  class: "property-read-only"
-};
-const _hoisted_8 = {
-  key: 9,
-  class: "property-required"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "SchemaPropertyHeading",
-  props: {
-    value: {},
-    enum: { type: Boolean },
-    isDiscriminator: { type: Boolean, default: false },
-    required: { type: Boolean, default: false },
-    additional: { type: Boolean },
-    withExamples: { type: Boolean, default: true },
-    hideModelNames: { type: Boolean, default: false },
-    modelName: {}
-  },
-  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 = resolve.schema(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 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 displayTitle = computed(() => {
-      if (!props.value) {
-        return null;
-      }
-      if (props.hideModelNames) {
-        return null;
-      }
-      if (props.modelName) {
-        return props.modelName;
-      }
-      const modelName = getModelNameFromSchema(props.value);
-      if (modelName) {
-        return modelName;
-      }
-      if (isArraySchema(props.value) && props.value.items) {
-        const itemName = getModelNameFromSchema(props.value.items);
-        return itemName ? `${itemName}[]` : null;
-      }
-      return null;
-    });
-    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 getSchemaType(props.value);
-    });
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock("div", _hoisted_1, [
-        _ctx.$slots.name ? (openBlock(), createElementBlock("div", {
-          key: 0,
-          class: normalizeClass(["property-name", { deprecated: props.value?.deprecated }])
-        }, [
-          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) + toDisplayString(displayTitle.value ? ` · ${displayTitle.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)
-        ], 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[4] || (_cache[4] = [
-              createTextVNode("deprecated", -1)
-            ])]),
-            _: 1
-          })
-        ])) : createCommentVNode("", true),
-        constValue.value !== void 0 ? (openBlock(), createElementBlock("div", _hoisted_5, [
-          createVNode(SchemaPropertyDetail, { truncate: "" }, {
-            prefix: withCtx(() => [..._cache[5] || (_cache[5] = [
-              createTextVNode("const: ", -1)
-            ])]),
-            default: withCtx(() => [
-              createVNode(_sfc_main$1, { value: constValue.value }, null, 8, ["value"])
-            ]),
-            _: 1
-          })
-        ])) : (openBlock(), createElementBlock(Fragment, { key: 6 }, [
-          props.value?.nullable === true ? (openBlock(), createBlock(SchemaPropertyDetail, { key: 0 }, {
-            default: withCtx(() => [..._cache[6] || (_cache[6] = [
-              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),
-        createVNode(SchemaPropertyDefault, {
-          value: props.value?.default
-        }, null, 8, ["value"]),
-        props.withExamples ? (openBlock(), createBlock(SchemaPropertyExamples, {
-          key: 10,
-          example: props.value?.example || props.value && unref(isArraySchema)(props.value) && unref(resolve).schema(props.value?.items)?.example,
-          examples: props.value?.examples
-        }, null, 8, ["example", "examples"])) : createCommentVNode("", true)
-      ]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

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

@@ -1,41 +0,0 @@
-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 {
-  formatExample
-};

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

@@ -1,35 +0,0 @@
-function formatValue(value) {
-  if (Array.isArray(value)) {
-    return `[${value.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 (value === null) {
-    return "null";
-  }
-  if (typeof value === "object") {
-    return JSON.stringify(value);
-  }
-  if (value === void 0) {
-    return "undefined";
-  }
-  if (typeof value === "string") {
-    return value.trim();
-  }
-  return value.toString().trim();
-}
-export {
-  formatValue
-};

package/dist/components/Content/Schema/helpers/get-compositions-to-render.js

@@ -1,31 +0,0 @@
-import { isDefined } from "@scalar/helpers/array/is-defined";
-import { resolve } from "@scalar/workspace-store/resolve";
-import { isArraySchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
-import { compositions } from "./schema-composition.js";
-import { shouldRenderArrayItemComposition } from "./should-render-array-item-composition.js";
-const getCompositionsToRender = (value) => {
-  if (!value) {
-    return [];
-  }
-  return compositions.map((composition) => {
-    if (shouldRenderArrayItemComposition(value, composition) && isArraySchema(value) && value.items) {
-      return {
-        composition,
-        value: resolve.schema(value.items)
-      };
-    }
-    if (value[composition]) {
-      const hasArrayItemComposition = isArraySchema(value) && value.items && typeof value.items === "object" && composition in value.items;
-      if (!hasArrayItemComposition) {
-        return {
-          composition,
-          value: resolve.schema(value)
-        };
-      }
-    }
-    return null;
-  }).filter(isDefined);
-};
-export {
-  getCompositionsToRender
-};

package/dist/components/Content/Schema/helpers/get-enum-values.js

@@ -1,20 +0,0 @@
-import { resolve } from "@scalar/workspace-store/resolve";
-import { isArraySchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
-const getEnumValues = (value) => {
-  if (!value) {
-    return [];
-  }
-  if (value.enum) {
-    return value.enum;
-  }
-  if (isArraySchema(value) && typeof value.items === "object") {
-    const resolvedItems = resolve.schema(value.items);
-    if (resolvedItems && "enum" in resolvedItems && resolvedItems.enum) {
-      return resolvedItems.enum;
-    }
-  }
-  return [];
-};
-export {
-  getEnumValues
-};

package/dist/components/Content/Schema/helpers/get-property-description.js

@@ -1,34 +0,0 @@
-import { isSchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
-const TYPE_DESCRIPTIONS = {
-  integer: {
-    _default: "Integer numbers.",
-    int32: "Signed 32-bit integers (commonly used integer type).",
-    int64: "Signed 64-bit integers (long type)."
-  },
-  string: {
-    "date": "full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21",
-    "date-time": "the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z",
-    "password": "a hint to UIs to mask the input",
-    "base64": "base64-encoded characters, for example, U3dhZ2dlciByb2Nrcw==",
-    "byte": "base64-encoded characters, for example, U3dhZ2dlciByb2Nrcw==",
-    "binary": "binary data, used to describe files"
-  }
-};
-const getPropertyDescription = (value) => {
-  if (!isSchema(value)) {
-    return null;
-  }
-  const type = Array.isArray(value.type) ? value.type[0] : value.type;
-  if (!type) {
-    return null;
-  }
-  const typeDescriptions = TYPE_DESCRIPTIONS[type];
-  if (!typeDescriptions) {
-    return null;
-  }
-  const format = "format" in value && value.format || "contentEncoding" in value && value.contentEncoding || "_default";
-  return typeDescriptions[format] ?? null;
-};
-export {
-  getPropertyDescription
-};

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

@@ -1,14 +0,0 @@
-import { REGEX } from "@scalar/helpers/regex/regex-helpers";
-const getRefName = (ref) => {
-  if (!ref) {
-    return null;
-  }
-  const match = ref.match(REGEX.REF_NAME);
-  if (match) {
-    return match[1];
-  }
-  return null;
-};
-export {
-  getRefName
-};