@scalar/api-reference 1.38.1 → 1.39.1

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

@@ -1,52 +1,61 @@
-import { defineComponent as i, createElementBlock as n, openBlock as c, createElementVNode as o, createVNode as t, unref as s, createTextVNode as p, toDisplayString as r } from "vue";
-import { ScalarIconCaretRight as m } from "@scalar/icons";
-import { getResolvedRef as a } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import d from "../OperationParameters.vue.js";
-import u from "../OperationResponses.vue.js";
-import f from "../../../../components/HttpMethod/HttpMethod.vue.js";
-const b = { class: "group callback-list-item" }, h = { 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-3 text-sm group-open:flex-wrap" }, _ = { class: "text-c-1 min-w-0 flex-1 truncate leading-3 group-open:whitespace-normal" }, k = { class: "text-c-2" }, g = { class: "callback-operation-container flex flex-col gap-2" }, S = /* @__PURE__ */ i({
+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-3 text-sm group-open:flex-wrap" };
+const _hoisted_3 = { class: "text-c-1 min-w-0 flex-1 truncate leading-3 group-open:whitespace-normal" };
+const _hoisted_4 = { class: "text-c-2" };
+const _hoisted_5 = { class: "callback-operation-container flex flex-col gap-2" };
+const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "Callback",
   props: {
     callback: {},
     method: {},
     name: {},
     url: {},
-    breadcrumb: {},
+    eventBus: {},
     options: {}
   },
-  setup(y) {
-    return (e, B) => (c(), n("details", b, [
-      o("summary", h, [
-        t(s(m), { class: "callback-list-item-icon text-c-3 group-hover:text-c-1 absolute top-3.5 -left-5 size-4 transition-transform duration-100 group-open:rotate-90" }),
-        t(s(f), {
-          as: "span",
-          class: "request-method py-0.75",
-          method: e.method
-        }, null, 8, ["method"]),
-        o("div", _, [
-          p(r(e.name) + " ", 1),
-          o("span", k, r(e.url), 1)
+  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-4 transition-transform duration-100 group-open:rotate-90" }),
+          createVNode(unref(_sfc_main$1), {
+            as: "span",
+            class: "request-method py-0.75",
+            method: _ctx.method
+          }, null, 8, ["method"]),
+          createElementVNode("div", _hoisted_3, [
+            createTextVNode(toDisplayString(_ctx.name) + " ", 1),
+            createElementVNode("span", _hoisted_4, toDisplayString(_ctx.url), 1)
+          ])
+        ]),
+        createElementVNode("div", _hoisted_5, [
+          createVNode(_sfc_main$2, {
+            eventBus: _ctx.eventBus,
+            options: _ctx.options,
+            parameters: _ctx.callback.parameters?.map((param) => unref(getResolvedRef)(param)) ?? [],
+            requestBody: unref(getResolvedRef)(_ctx.callback.requestBody)
+          }, null, 8, ["eventBus", "options", "parameters", "requestBody"]),
+          createVNode(_sfc_main$3, {
+            collapsableItems: false,
+            eventBus: _ctx.eventBus,
+            options: {
+              collapsableItems: true,
+              orderRequiredPropertiesFirst: _ctx.options.orderRequiredPropertiesFirst,
+              orderSchemaPropertiesBy: _ctx.options.orderSchemaPropertiesBy
+            },
+            responses: _ctx.callback.responses
+          }, null, 8, ["eventBus", "options", "responses"])
         ])
-      ]),
-      o("div", g, [
-        t(d, {
-          options: e.options,
-          parameters: e.callback.parameters?.map((l) => s(a)(l)) ?? [],
-          requestBody: s(a)(e.callback.requestBody)
-        }, null, 8, ["options", "parameters", "requestBody"]),
-        t(u, {
-          collapsableItems: !1,
-          options: {
-            collapsableItems: !0,
-            orderRequiredPropertiesFirst: e.options.orderRequiredPropertiesFirst,
-            orderSchemaPropertiesBy: e.options.orderSchemaPropertiesBy
-          },
-          responses: e.callback.responses
-        }, null, 8, ["options", "responses"])
-      ])
-    ]));
+      ]);
+    };
   }
 });
 export {
-  S as default
+  _sfc_main as default
 };

package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts

@@ -1,9 +1,11 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { CallbackObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 type __VLS_Props = {
     path: string;
     method: HttpMethod;
     callbacks: CallbackObject;
+    eventBus: WorkspaceEventBus | null;
     options: {
         collapsableItems?: boolean;
         withExamples?: boolean;

package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Callbacks.vue.d.ts","sourceRoot":"","sources":["../../../../../src/features/Operation/components/callbacks/Callbacks.vue"],"names":[],"mappings":"AAyDA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AAIlG,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,cAAc,CAAA;IACzB,OAAO,EAAE;QACP,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AAgFF,wBAMG"}
+{"version":3,"file":"Callbacks.vue.d.ts","sourceRoot":"","sources":["../../../../../src/features/Operation/components/callbacks/Callbacks.vue"],"names":[],"mappings":"AA8DA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAEvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AAIlG,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,cAAc,CAAA;IACzB,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,OAAO,EAAE;QACP,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AAoFF,wBAMG"}

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

@@ -1,37 +1,52 @@
-import { defineComponent as k, createElementBlock as t, openBlock as e, createElementVNode as f, Fragment as o, renderList as n, unref as m, createBlock as h, createCommentVNode as b } from "vue";
-import { isHttpMethod as C } from "@scalar/helpers/http/is-http-method";
-import { getResolvedRef as g } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import y from "./Callback.vue.js";
-const v = { class: "callbacks-list gap-3" }, R = /* @__PURE__ */ k({
+import { defineComponent, createElementBlock, openBlock, createElementVNode, Fragment, renderList, unref, createBlock, createCommentVNode } from "vue";
+import { isHttpMethod } from "@scalar/helpers/http/is-http-method";
+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: {},
     method: {},
     callbacks: {},
+    eventBus: {},
     options: {}
   },
-  setup(p) {
-    return (l, a) => (e(), t("div", v, [
-      a[0] || (a[0] = f("div", { class: "callbacks-title text-c-1 my-3 text-lg font-medium" }, " Callbacks ", -1)),
-      (e(!0), t(o, null, n(l.callbacks, (i, s) => (e(), t(o, { key: s }, [
-        (e(!0), t(o, null, n(m(g)(i), (u, c) => (e(), t(o, null, [
-          (e(!0), t(o, null, n(u, (d, r) => (e(), t(o, { key: r }, [
-            m(C)(r) ? (e(), h(y, {
-              key: 0,
-              callback: d,
-              method: r,
-              name: s,
-              operationMethod: p.method,
-              options: l.options,
-              path: l.path,
-              url: c
-            }, null, 8, ["callback", "method", "name", "operationMethod", "options", "path", "url"])) : b("", !0)
-          ], 64))), 128))
-        ], 64))), 256))
-      ], 64))), 128))
-    ]));
+  setup(__props) {
+    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(_ctx.callbacks, (pathItem, name) => {
+          return openBlock(), createElementBlock(Fragment, { key: name }, [
+            (openBlock(true), createElementBlock(Fragment, null, renderList(unref(getResolvedRef)(pathItem), (methods, url) => {
+              return openBlock(), createElementBlock(Fragment, null, [
+                (openBlock(true), createElementBlock(Fragment, null, renderList(methods, (callback, callbackMethod) => {
+                  return openBlock(), createElementBlock(Fragment, { key: callbackMethod }, [
+                    unref(isHttpMethod)(callbackMethod) ? (openBlock(), createBlock(Callback, {
+                      key: 0,
+                      callback,
+                      eventBus: _ctx.eventBus,
+                      method: callbackMethod,
+                      name,
+                      operationMethod: __props.method,
+                      options: _ctx.options,
+                      path: _ctx.path,
+                      url
+                    }, null, 8, ["callback", "eventBus", "method", "name", "operationMethod", "options", "path", "url"])) : createCommentVNode("", true)
+                  ], 64);
+                }), 128))
+              ], 64);
+            }), 256))
+          ], 64);
+        }), 128))
+      ]);
+    };
   }
 });
 export {
-  R as default
+  _sfc_main as default
 };

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

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

package/dist/features/Operation/helpers/combine-params.js

@@ -1,13 +1,14 @@
-import { isDefined as s } from "@scalar/helpers/array/is-defined";
-import { getResolvedRef as t } from "@scalar/workspace-store/helpers/get-resolved-ref";
-const c = (a = [], o = []) => {
-  const m = [...a, ...o].map((e) => t(e)).filter((e) => s(e) && e.name), r = /* @__PURE__ */ new Map();
-  for (const e of m) {
-    const n = `${e.in}:${e.name}`;
-    r.set(n, e);
+import { isDefined } from "@scalar/helpers/array/is-defined";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+const combineParams = (pathParams = [], operationParams = []) => {
+  const allParams = [...pathParams, ...operationParams].map((param) => getResolvedRef(param)).filter((e) => isDefined(e) && e.name);
+  const uniqueParams = /* @__PURE__ */ new Map();
+  for (const param of allParams) {
+    const key = `${param.in}:${param.name}`;
+    uniqueParams.set(key, param);
   }
-  return Array.from(r.values());
+  return Array.from(uniqueParams.values());
 };
 export {
-  c as combineParams
+  combineParams
 };

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

@@ -1,20 +1,25 @@
-import { getResolvedRef as t } from "@scalar/workspace-store/helpers/get-resolved-ref";
-function i(...n) {
-  for (const r of n)
-    if (r) {
-      if (!Array.isArray(r)) {
-        const e = t(r);
-        if (e?.url)
-          return e;
-        continue;
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+function getFirstServer(...availableServers) {
+  for (const serverSource of availableServers) {
+    if (!serverSource) {
+      continue;
+    }
+    if (!Array.isArray(serverSource)) {
+      const resolvedServer = getResolvedRef(serverSource);
+      if (resolvedServer?.url) {
+        return resolvedServer;
       }
-      for (const e of r) {
-        const o = t(e);
-        if (o?.url)
-          return o;
+      continue;
+    }
+    for (const server of serverSource) {
+      const resolvedServer = getResolvedRef(server);
+      if (resolvedServer?.url) {
+        return resolvedServer;
       }
     }
+  }
+  return void 0;
 }
 export {
-  i as getFirstServer
+  getFirstServer
 };

package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts

@@ -1,6 +1,7 @@
 import { type ClientOptionGroup } from '@scalar/api-client/v2/blocks/operation-code-sample';
 import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
 import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { OperationObject, SecuritySchemeObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 type __VLS_Props = {
     id: string;
@@ -9,7 +10,9 @@ type __VLS_Props = {
     operation: OperationObject;
     server: ServerObject | undefined;
     securitySchemes: SecuritySchemeObject[];
-    store: WorkspaceStore;
+    xScalarDefaultClient: WorkspaceStore['workspace']['x-scalar-default-client'];
+    isCollapsed: boolean;
+    eventBus: WorkspaceEventBus | null;
     /** Global options that can be derived from the top level config or assigned at a block level */
     options: {
         /** Sets some additional display properties when an operation is a webhook */

package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClassicLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ClassicLayout.vue"],"names":[],"mappings":"AAudA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,oDAAoD,CAAA;AAM3D,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAYrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAiBrE,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,eAAe,CAAA;IAE1B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,KAAK,EAAE,cAAc,CAAA;IACrB,gGAAgG;IAChG,OAAO,EAAE;QACP,6EAA6E;QAC7E,SAAS,EAAE,OAAO,CAAA;QAClB,aAAa,EAAE,iBAAiB,EAAE,CAAA;QAClC,eAAe,EAAE,OAAO,GAAG,SAAS,CAAA;QACpC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1C,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AA8gBF,wBAMG"}
+{"version":3,"file":"ClassicLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ClassicLayout.vue"],"names":[],"mappings":"AAoeA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,oDAAoD,CAAA;AAM3D,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAYrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAEvE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAiBrE,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,eAAe,CAAA;IAE1B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,oBAAoB,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC,yBAAyB,CAAC,CAAA;IAC5E,WAAW,EAAE,OAAO,CAAA;IACpB,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,gGAAgG;IAChG,OAAO,EAAE;QACP,6EAA6E;QAC7E,SAAS,EAAE,OAAO,CAAA;QAClB,aAAa,EAAE,iBAAiB,EAAE,CAAA;QAClC,eAAe,EAAE,OAAO,GAAG,SAAS,CAAA;QACpC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1C,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AA0iBF,wBAMG"}

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

@@ -1,7 +1,7 @@
-import o from "./ClassicLayout.vue2.js";
+import _sfc_main from "./ClassicLayout.vue2.js";
 /* empty css                   */
-import t from "../../../_virtual/_plugin-vue_export-helper.js";
-const c = /* @__PURE__ */ t(o, [["__scopeId", "data-v-4fb6913c"]]);
+import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
+const ClassicLayout = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-86cb6452"]]);
 export {
-  c as default
+  ClassicLayout as default
 };