@scalar/api-reference 1.48.8 → 1.49.1

package/dist/features/Operation/components/ParameterListItem.vue2.js

@@ -1,163 +0,0 @@
-import { defineComponent, computed, ref, createElementBlock, openBlock, createVNode, unref, withCtx, createBlock, createCommentVNode, normalizeClass, createElementVNode } from "vue";
-import { Disclosure, DisclosureButton, DisclosurePanel } from "@headlessui/vue";
-import { ScalarWrappingText, ScalarMarkdownSummary, ScalarMarkdown } from "@scalar/components";
-import { ScalarIconCaretRight } from "@scalar/icons";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { getRefName } from "../../../components/Content/Schema/helpers/get-ref-name.js";
-import SchemaProperty from "../../../components/Content/Schema/SchemaProperty.vue.js";
-import _sfc_main$1 from "./ContentTypeSelect.vue.js";
-import Headers from "./Headers.vue.js";
-const _hoisted_1 = { class: "parameter-item group/parameter-item" };
-const _hoisted_2 = { class: "parameter-item-name min-w-0" };
-const _hoisted_3 = {
-  key: 1,
-  class: "flex-1"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "ParameterListItem",
-  props: {
-    parameter: {},
-    name: {},
-    breadcrumb: {},
-    eventBus: {},
-    collapsableItems: { type: Boolean },
-    options: {}
-  },
-  setup(__props) {
-    const schema = computed(
-      () => "schema" in __props.parameter && __props.parameter.schema ? getResolvedRef(__props.parameter.schema) : null
-    );
-    const content = computed(
-      () => "content" in __props.parameter && __props.parameter.content ? __props.parameter.content : null
-    );
-    const selectedContentType = ref(
-      Object.keys(content.value || {})[0] ?? ""
-    );
-    const headers = computed(
-      () => "headers" in __props.parameter && __props.parameter.headers ? __props.parameter.headers : null
-    );
-    const baseSchema = computed(
-      () => content.value ? content.value?.[selectedContentType.value]?.schema : "schema" in __props.parameter && __props.parameter.schema ? __props.parameter.schema : null
-    );
-    const schemaModelName = computed(() => {
-      const raw = baseSchema.value;
-      if (!raw) {
-        return null;
-      }
-      if ("$ref" in raw) {
-        return getRefName(raw.$ref);
-      }
-      return null;
-    });
-    const value = computed(() => {
-      const base = baseSchema.value;
-      const resolvedBase = content.value ? getResolvedRef(base) : schema.value;
-      const deprecated = "deprecated" in __props.parameter ? __props.parameter.deprecated : schema.value?.deprecated;
-      const paramExamples = "examples" in __props.parameter ? __props.parameter.examples : {};
-      const recordExamples = Object.values({
-        ...paramExamples,
-        ...content.value?.[selectedContentType.value]?.examples
-      });
-      const arrayExamples = schema.value?.examples ?? (recordExamples.length === 0 && "example" in __props.parameter ? [__props.parameter.example] : []);
-      const examples = [...recordExamples, ...arrayExamples];
-      return {
-        ...resolvedBase,
-        deprecated,
-        examples
-      };
-    });
-    const shouldCollapse = computed(
-      () => Boolean(__props.collapsableItems && (content.value || headers.value || schema.value))
-    );
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock("li", _hoisted_1, [
-        createVNode(unref(Disclosure), null, {
-          default: withCtx(({ open }) => [
-            shouldCollapse.value ? (openBlock(), createBlock(unref(DisclosureButton), {
-              key: 0,
-              class: normalizeClass(["parameter-item-trigger", { "parameter-item-trigger-open": open }])
-            }, {
-              default: withCtx(() => [
-                createElementVNode("div", _hoisted_2, [
-                  createVNode(unref(ScalarIconCaretRight), {
-                    class: normalizeClass(["parameter-item-icon size-3 transition-transform duration-100", { "rotate-90": open }]),
-                    weight: "bold"
-                  }, null, 8, ["class"]),
-                  createElementVNode("div", null, [
-                    createVNode(unref(ScalarWrappingText), {
-                      preset: "property",
-                      text: __props.name
-                    }, null, 8, ["text"])
-                  ])
-                ]),
-                !open && __props.parameter.description ? (openBlock(), createBlock(unref(ScalarMarkdownSummary), {
-                  key: 0,
-                  class: "parameter-item-description-summary min-w-0 flex-1",
-                  controlled: "",
-                  value: __props.parameter.description
-                }, null, 8, ["value"])) : (openBlock(), createElementBlock("div", _hoisted_3)),
-                createElementVNode("div", {
-                  class: normalizeClass(["absolute top-[calc(9px+0.5lh)] right-0 z-0 flex -translate-y-1/2 items-center", {
-                    "opacity-0 group-focus-within/parameter-item:opacity-100 group-hover/parameter-item:opacity-100": !open
-                  }])
-                }, [
-                  _cache[1] || (_cache[1] = createElementVNode("div", { class: "from-b-1 absolute inset-y-0 -left-6 -z-1 w-8 bg-linear-to-l from-40% to-transparent" }, null, -1)),
-                  shouldCollapse.value && content.value ? (openBlock(), createBlock(_sfc_main$1, {
-                    key: 0,
-                    modelValue: selectedContentType.value,
-                    "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => selectedContentType.value = $event),
-                    content: content.value
-                  }, null, 8, ["modelValue", "content"])) : createCommentVNode("", true)
-                ], 2)
-              ]),
-              _: 2
-            }, 1032, ["class"])) : createCommentVNode("", true),
-            createVNode(unref(DisclosurePanel), {
-              class: "parameter-item-container parameter-item-container-markdown",
-              static: !shouldCollapse.value
-            }, {
-              default: withCtx(() => [
-                shouldCollapse.value && __props.parameter.description ? (openBlock(), createBlock(unref(ScalarMarkdown), {
-                  key: 0,
-                  class: "parameter-item-description",
-                  value: __props.parameter.description
-                }, null, 8, ["value"])) : createCommentVNode("", true),
-                headers.value ? (openBlock(), createBlock(Headers, {
-                  key: 1,
-                  breadcrumb: __props.breadcrumb,
-                  eventBus: __props.eventBus,
-                  headers: headers.value,
-                  orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst,
-                  orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy
-                }, null, 8, ["breadcrumb", "eventBus", "headers", "orderRequiredPropertiesFirst", "orderSchemaPropertiesBy"])) : createCommentVNode("", true),
-                createVNode(SchemaProperty, {
-                  is: "div",
-                  breadcrumb: __props.breadcrumb,
-                  compact: "",
-                  description: shouldCollapse.value ? "" : __props.parameter.description,
-                  eventBus: __props.eventBus,
-                  hideWriteOnly: true,
-                  modelName: schemaModelName.value,
-                  name: shouldCollapse.value ? "" : __props.name,
-                  noncollapsible: true,
-                  options: {
-                    hideWriteOnly: true,
-                    orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst,
-                    orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy
-                  },
-                  required: "required" in __props.parameter && __props.parameter.required,
-                  schema: value.value
-                }, null, 8, ["breadcrumb", "description", "eventBus", "modelName", "name", "options", "required", "schema"])
-              ]),
-              _: 1
-            }, 8, ["static"])
-          ]),
-          _: 1
-        })
-      ]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/Operation/components/RequestBody.vue.js

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

package/dist/features/Operation/components/RequestBody.vue2.js

@@ -1,164 +0,0 @@
-import { defineComponent, computed, ref, createElementBlock, createCommentVNode, openBlock, createElementVNode, renderSlot, createVNode, unref } from "vue";
-import { ScalarMarkdown } from "@scalar/components";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { isTypeObject } from "../../../components/Content/Schema/helpers/is-type-object.js";
-import { sortPropertyNames, reduceNamesToObject } from "../../../components/Content/Schema/helpers/sort-property-names.js";
-import _sfc_main$1 from "./ContentTypeSelect.vue.js";
-import Schema from "../../../components/Content/Schema/Schema.vue.js";
-const _hoisted_1 = {
-  key: 0,
-  "aria-label": "Request Body",
-  class: "request-body",
-  role: "group"
-};
-const _hoisted_2 = { class: "request-body-header" };
-const _hoisted_3 = { class: "request-body-title" };
-const _hoisted_4 = { class: "flex items-center gap-2" };
-const _hoisted_5 = {
-  key: 0,
-  class: "request-body-required"
-};
-const _hoisted_6 = {
-  key: 0,
-  class: "request-body-description"
-};
-const _hoisted_7 = {
-  key: 0,
-  class: "request-body-schema"
-};
-const _hoisted_8 = {
-  key: 1,
-  class: "request-body-schema"
-};
-const MAX_VISIBLE_PROPERTIES = 12;
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "RequestBody",
-  props: {
-    breadcrumb: {},
-    requestBody: {},
-    eventBus: {},
-    options: {}
-  },
-  setup(__props) {
-    const availableContentTypes = computed(
-      () => Object.keys(__props.requestBody?.content ?? {})
-    );
-    const selectedContentType = ref("application/json");
-    if (__props.requestBody?.content) {
-      if (availableContentTypes.value[0]) {
-        selectedContentType.value = availableContentTypes.value[0];
-      }
-    }
-    const schema = computed(
-      () => getResolvedRef(__props.requestBody?.content?.[selectedContentType.value]?.schema)
-    );
-    const partitionedSchema = computed(() => {
-      if (!schema.value || !isTypeObject(schema.value)) {
-        return null;
-      }
-      const sortedNames = sortPropertyNames(
-        schema.value,
-        schema.value.discriminator,
-        {
-          hideReadOnly: true,
-          orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy,
-          orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst
-        }
-      );
-      if (sortedNames.length <= MAX_VISIBLE_PROPERTIES) {
-        return null;
-      }
-      const { properties, ...schemaMetadata } = schema.value;
-      if (!properties) {
-        return null;
-      }
-      return {
-        visibleProperties: {
-          ...schemaMetadata,
-          properties: reduceNamesToObject(
-            sortedNames.slice(0, MAX_VISIBLE_PROPERTIES),
-            properties
-          )
-        },
-        collapsedProperties: {
-          ...schemaMetadata,
-          properties: reduceNamesToObject(
-            sortedNames.slice(MAX_VISIBLE_PROPERTIES),
-            properties
-          )
-        }
-      };
-    });
-    const shouldRenderRequestBody = computed(
-      () => Object.keys(__props.requestBody?.content ?? {}).length > 0 || __props.requestBody?.description || __props.requestBody?.required
-    );
-    return (_ctx, _cache) => {
-      return __props.requestBody && shouldRenderRequestBody.value ? (openBlock(), createElementBlock("div", _hoisted_1, [
-        createElementVNode("div", _hoisted_2, [
-          createElementVNode("div", _hoisted_3, [
-            renderSlot(_ctx.$slots, "title", {}, void 0, true)
-          ]),
-          createElementVNode("div", _hoisted_4, [
-            __props.requestBody.required ? (openBlock(), createElementBlock("div", _hoisted_5, " required ")) : createCommentVNode("", true),
-            createVNode(_sfc_main$1, {
-              modelValue: selectedContentType.value,
-              "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => selectedContentType.value = $event),
-              content: __props.requestBody.content
-            }, null, 8, ["modelValue", "content"])
-          ]),
-          __props.requestBody.description ? (openBlock(), createElementBlock("div", _hoisted_6, [
-            createVNode(unref(ScalarMarkdown), {
-              value: __props.requestBody.description
-            }, null, 8, ["value"])
-          ])) : createCommentVNode("", true)
-        ]),
-        partitionedSchema.value ? (openBlock(), createElementBlock("div", _hoisted_7, [
-          createVNode(unref(Schema), {
-            breadcrumb: __props.breadcrumb,
-            compact: "",
-            eventBus: __props.eventBus,
-            name: "Request Body",
-            noncollapsible: "",
-            options: {
-              hideReadOnly: true,
-              orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst,
-              orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy
-            },
-            schema: partitionedSchema.value.visibleProperties
-          }, null, 8, ["breadcrumb", "eventBus", "options", "schema"]),
-          createVNode(unref(Schema), {
-            additionalProperties: "",
-            breadcrumb: __props.breadcrumb,
-            compact: "",
-            eventBus: __props.eventBus,
-            name: "Request Body",
-            options: {
-              hideReadOnly: true,
-              orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst,
-              orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy
-            },
-            schema: partitionedSchema.value.collapsedProperties
-          }, null, 8, ["breadcrumb", "eventBus", "options", "schema"])
-        ])) : schema.value ? (openBlock(), createElementBlock("div", _hoisted_8, [
-          createVNode(unref(Schema), {
-            breadcrumb: __props.breadcrumb,
-            compact: "",
-            eventBus: __props.eventBus,
-            hideReadOnly: true,
-            name: "Request Body",
-            noncollapsible: "",
-            options: {
-              hideReadOnly: true,
-              orderRequiredPropertiesFirst: __props.options.orderRequiredPropertiesFirst,
-              orderSchemaPropertiesBy: __props.options.orderSchemaPropertiesBy
-            },
-            schema: schema.value
-          }, null, 8, ["breadcrumb", "eventBus", "options", "schema"])
-        ])) : createCommentVNode("", true)
-      ])) : createCommentVNode("", true);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/Operation/components/callbacks/Callback.vue.js

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

package/dist/features/Operation/components/callbacks/Callback.vue2.js

@@ -1,60 +0,0 @@
-import { defineComponent, createElementBlock, openBlock, createElementVNode, createVNode, unref, createTextVNode, toDisplayString } from "vue";
-import { ScalarIconCaretRight } from "@scalar/icons";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import _sfc_main$2 from "../OperationParameters.vue.js";
-import _sfc_main$3 from "../OperationResponses.vue.js";
-import _sfc_main$1 from "../../../../components/HttpMethod/HttpMethod.vue.js";
-const _hoisted_1 = { class: "group callback-list-item" };
-const _hoisted_2 = { class: "font-code bg-b-1 callback-sticky-offset callback-list-item-title sticky flex cursor-pointer flex-row items-start gap-2 border-t py-2.5 text-sm group-open:flex-wrap" };
-const _hoisted_3 = { class: "text-c-1 min-w-0 flex-1 truncate text-sm leading-5 font-bold group-open:whitespace-normal" };
-const _hoisted_4 = { class: "text-c-2 font-normal" };
-const _hoisted_5 = { class: "callback-operation-container flex flex-col gap-2" };
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "Callback",
-  props: {
-    callback: {},
-    method: {},
-    name: {},
-    url: {},
-    eventBus: {},
-    options: {}
-  },
-  setup(__props) {
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock("details", _hoisted_1, [
-        createElementVNode("summary", _hoisted_2, [
-          createVNode(unref(ScalarIconCaretRight), {
-            class: "callback-list-item-icon text-c-3 group-hover:text-c-1 absolute top-3.5 -left-5 size-3 transition-transform duration-100 group-open:rotate-90",
-            weight: "bold"
-          }),
-          createVNode(unref(_sfc_main$1), {
-            as: "span",
-            class: "request-method py-0.75 font-bold",
-            method: __props.method
-          }, null, 8, ["method"]),
-          createElementVNode("div", _hoisted_3, [
-            createTextVNode(toDisplayString(__props.name) + " ", 1),
-            createElementVNode("span", _hoisted_4, toDisplayString(__props.url), 1)
-          ])
-        ]),
-        createElementVNode("div", _hoisted_5, [
-          createVNode(_sfc_main$2, {
-            eventBus: __props.eventBus,
-            options: __props.options,
-            parameters: __props.callback.parameters?.map((param) => unref(getResolvedRef)(param)) ?? [],
-            requestBody: unref(getResolvedRef)(__props.callback.requestBody)
-          }, null, 8, ["eventBus", "options", "parameters", "requestBody"]),
-          createVNode(_sfc_main$3, {
-            collapsableItems: false,
-            eventBus: __props.eventBus,
-            options: __props.options,
-            responses: __props.callback.responses
-          }, null, 8, ["eventBus", "options", "responses"])
-        ])
-      ]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/Operation/components/callbacks/Callbacks.vue.js

@@ -1,63 +0,0 @@
-import { defineComponent, computed, createElementBlock, openBlock, createElementVNode, Fragment, renderList, createBlock } from "vue";
-import { isHttpMethod } from "@scalar/helpers/http/is-http-method";
-import { objectEntries } from "@scalar/helpers/object/object-entries";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import Callback from "./Callback.vue.js";
-const _hoisted_1 = {
-  "aria-label": "Callbacks",
-  class: "callbacks-list gap-3",
-  role: "group"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "Callbacks",
-  props: {
-    path: {},
-    callbacks: {},
-    eventBus: {},
-    options: {}
-  },
-  setup(__props) {
-    const flattenedCallbacks = computed(() => {
-      const _callbacks = [];
-      objectEntries(__props.callbacks).forEach(([name, pathItem]) => {
-        objectEntries(getResolvedRef(pathItem)).forEach(([url, methods]) => {
-          if (typeof methods !== "object" || !methods) {
-            return;
-          }
-          objectEntries(methods).forEach(([callbackMethod, callback]) => {
-            if (!isHttpMethod(callbackMethod)) {
-              return;
-            }
-            _callbacks.push({
-              name,
-              url,
-              method: callbackMethod,
-              callback
-            });
-          });
-        });
-      });
-      return _callbacks;
-    });
-    return (_ctx, _cache) => {
-      return openBlock(), createElementBlock("div", _hoisted_1, [
-        _cache[0] || (_cache[0] = createElementVNode("div", { class: "callbacks-title text-c-1 my-3 text-lg font-medium" }, " Callbacks ", -1)),
-        (openBlock(true), createElementBlock(Fragment, null, renderList(flattenedCallbacks.value, ({ callback, method, name, url }) => {
-          return openBlock(), createBlock(Callback, {
-            key: `${name}-${url}-${method}`,
-            callback,
-            eventBus: __props.eventBus,
-            method,
-            name,
-            options: __props.options,
-            path: __props.path,
-            url
-          }, null, 8, ["callback", "eventBus", "method", "name", "options", "path", "url"]);
-        }), 128))
-      ]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/Operation/components/callbacks/Callbacks.vue2.js

@@ -1,4 +0,0 @@
-import _sfc_main from "./Callbacks.vue.js";
-export {
-  _sfc_main as default
-};

package/dist/features/Operation/helpers/filter-selected-security.js

@@ -1,28 +0,0 @@
-import { getSecuritySchemes } from "@scalar/api-client/v2/blocks/operation-block";
-import { getSelectedSecurity } from "@scalar/api-client/v2/features/operation";
-const getKey = (requirement) => Object.keys(requirement).sort().join(",");
-const filterSelectedSecurity = (document, operation, selectedSecurityDocument, selectedSecurityOperation, securitySchemes = {}) => {
-  const securityRequirements = operation?.security ?? document.security ?? [];
-  const selectedSecurity = getSelectedSecurity(
-    selectedSecurityDocument,
-    selectedSecurityOperation,
-    securityRequirements
-  );
-  const requirementSet = new Set(securityRequirements.map((r) => getKey(r)));
-  const selectedRequirement = selectedSecurity.selectedSchemes[selectedSecurity.selectedIndex];
-  if (selectedRequirement && requirementSet.has(getKey(selectedRequirement))) {
-    return getSecuritySchemes(securitySchemes, [selectedRequirement]);
-  }
-  for (const selected of selectedSecurity.selectedSchemes) {
-    if (requirementSet.has(getKey(selected))) {
-      return getSecuritySchemes(securitySchemes, [selected]);
-    }
-  }
-  if (operation?.security?.length) {
-    return getSecuritySchemes(securitySchemes, securityRequirements.slice(0, 1));
-  }
-  return [];
-};
-export {
-  filterSelectedSecurity
-};

package/dist/features/Operation/helpers/get-first-server.js

@@ -1,25 +0,0 @@
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-const getFirstServer = (...availableServers) => {
-  for (const serverSource of availableServers) {
-    if (!serverSource) {
-      continue;
-    }
-    if (!Array.isArray(serverSource)) {
-      const resolvedServer = getResolvedRef(serverSource);
-      if (resolvedServer?.url) {
-        return resolvedServer;
-      }
-      continue;
-    }
-    for (const server of serverSource) {
-      const resolvedServer = getResolvedRef(server);
-      if (resolvedServer?.url) {
-        return resolvedServer;
-      }
-    }
-  }
-  return null;
-};
-export {
-  getFirstServer
-};

package/dist/features/Operation/layouts/ClassicLayout.vue.js

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