@scalar/api-client 2.29.4 → 2.31.0

package/dist/v2/features/collection/components/LabelInput.vue.d.ts

@@ -1,11 +1,15 @@
+type __VLS_Props = {
+    placeholder?: string;
+};
 type __VLS_ModelProps = {
     modelValue: string;
 };
-declare const __VLS_export: import("vue").DefineComponent<__VLS_ModelProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string) => any;
 } & {
     blur: (value: string) => any;
-}, string, import("vue").PublicProps, Readonly<__VLS_ModelProps> & Readonly<{
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
     onBlur?: ((value: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/v2/features/collection/components/LabelInput.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LabelInput.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/LabelInput.vue"],"names":[],"mappings":"AAgEA,KAAK,gBAAgB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;CAClB,CAAC;AAgFF,QAAA,MAAM,YAAY;;;;;;;kFAGhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"LabelInput.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/LabelInput.vue"],"names":[],"mappings":"AAuDA,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAC;AAiBF,KAAK,gBAAgB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;CAClB,CAAC;AAKF,KAAK,iBAAiB,GAAG,WAAW,GAAG,gBAAgB,CAAC;AA2ExD,QAAA,MAAM,YAAY;;;;;;;kFAGhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/v2/features/collection/components/LabelInput.vue.js

@@ -1,7 +1,7 @@
 import o from "./LabelInput.vue2.js";
 /* empty css                */
 import t from "../../../../_virtual/_plugin-vue_export-helper.js";
-const f = /* @__PURE__ */ t(o, [["__scopeId", "data-v-9a6458fc"]]);
+const r = /* @__PURE__ */ t(o, [["__scopeId", "data-v-242ff9a6"]]);
 export {
-  f as default
+  r as default
 };

package/dist/v2/features/collection/components/LabelInput.vue2.js

@@ -1,29 +1,31 @@
-import { defineComponent as a, mergeModels as m, useModel as p, useId as c, createElementBlock as f, openBlock as v, createElementVNode as n, withDirectives as h, unref as u, withKeys as x, vModelText as _ } from "vue";
-const b = { class: "group pointer-events-none flex flex-1 items-center gap-1" }, g = ["for"], w = ["id"], M = /* @__PURE__ */ a({
+import { defineComponent as p, mergeModels as r, useModel as c, useId as m, createElementBlock as f, openBlock as v, createElementVNode as u, withDirectives as h, unref as s, withKeys as x, vModelText as b } from "vue";
+const _ = { class: "group pointer-events-none flex flex-1 items-center gap-1" }, g = ["for"], w = ["id", "placeholder"], M = /* @__PURE__ */ p({
   __name: "LabelInput",
-  props: {
+  props: /* @__PURE__ */ r({
+    placeholder: {}
+  }, {
     modelValue: { required: !0 },
     modelModifiers: {}
-  },
-  emits: /* @__PURE__ */ m(["blur"], ["update:modelValue"]),
-  setup(r, { emit: s }) {
-    const i = s, t = p(r, "modelValue"), o = c(), d = () => {
-      i("blur", t.value);
+  }),
+  emits: /* @__PURE__ */ r(["blur"], ["update:modelValue"]),
+  setup(o, { emit: d }) {
+    const i = d, l = c(o, "modelValue"), n = m(), a = () => {
+      i("blur", l.value);
     };
-    return (V, e) => (v(), f("div", b, [
-      n("label", {
+    return (V, e) => (v(), f("div", _, [
+      u("label", {
         class: "pointer-events-auto absolute top-0 left-0 h-full w-full cursor-text opacity-0",
-        for: u(o)
+        for: s(n)
       }, null, 8, g),
-      h(n("input", {
-        id: u(o),
-        "onUpdate:modelValue": e[0] || (e[0] = (l) => t.value = l),
+      h(u("input", {
+        id: s(n),
+        "onUpdate:modelValue": e[0] || (e[0] = (t) => l.value = t),
         class: "text-c-1 group-hover-input pointer-events-auto relative z-10 -ml-0.5 h-8 w-full flex-1 rounded pl-1.25 has-[:focus-visible]:outline md:-ml-1.25",
-        placeholder: "Untitled Document",
-        onBlur: d,
-        onKeydown: e[1] || (e[1] = x((l) => l.target?.blur(), ["enter"]))
+        placeholder: o.placeholder ?? "Untitled Document",
+        onBlur: a,
+        onKeydown: e[1] || (e[1] = x((t) => t.target?.blur(), ["enter"]))
       }, null, 40, w), [
-        [_, t.value]
+        [b, l.value]
       ])
     ]));
   }

package/dist/v2/features/collection/components/Overview.vue.d.ts

@@ -1,11 +1,11 @@
 declare const __VLS_export: import("vue").DefineComponent<(import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
-    collectionType: "document";
+    collectionType: "document" | "operation";
     document: import("@scalar/workspace-store/schemas").WorkspaceDocument;
 }) | (import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
     collectionType: "workspace";
     document: null;
 }), {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<(import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
-    collectionType: "document";
+    collectionType: "document" | "operation";
     document: import("@scalar/workspace-store/schemas").WorkspaceDocument;
 }) | (import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
     collectionType: "workspace";

package/dist/v2/features/collection/components/Overview.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Overview.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/Overview.vue"],"names":[],"mappings":"AA2aA,QAAA,MAAM,YAAY;;;;;;;;;;;;kGAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"Overview.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/Overview.vue"],"names":[],"mappings":"AAm3BA,QAAA,MAAM,YAAY;;;;;;;;;;;;kGAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/v2/features/collection/components/Overview.vue.js

@@ -1,7 +1,7 @@
 import o from "./Overview.vue2.js";
 /* empty css              */
 import r from "../../../../_virtual/_plugin-vue_export-helper.js";
-const m = /* @__PURE__ */ r(o, [["__scopeId", "data-v-59dae578"]]);
+const m = /* @__PURE__ */ r(o, [["__scopeId", "data-v-d486ea71"]]);
 export {
   m as default
 };

package/dist/v2/features/collection/components/Overview.vue2.js

@@ -1,12 +1,14 @@
-import { defineComponent as g, computed as x, ref as y, useTemplateRef as w, createBlock as c, openBlock as t, withCtx as r, createElementVNode as l, createElementBlock as p, Fragment as f, createVNode as s, unref as o, createCommentVNode as B, createTextVNode as V, nextTick as h } from "vue";
-import { ScalarMarkdown as C, ScalarButton as k } from "@scalar/components";
-import { ScalarIconPencil as b } from "@scalar/icons";
-import I from "../../settings/components/Section.vue.js";
-import S from "../../../components/code-input/CodeInput.vue.js";
-const z = { class: "has-focus-visible:bg-b-1 group rounded-lg" }, N = {
+import { defineComponent as V, computed as b, ref as z, useTemplateRef as I, createElementBlock as d, openBlock as r, Fragment as m, createElementVNode as o, createVNode as a, createCommentVNode as w, withCtx as l, createBlock as T, unref as n, createTextVNode as f, normalizeClass as C, nextTick as N } from "vue";
+import { useModal as O, ScalarMarkdown as R, ScalarButton as p, ScalarToggle as U, ScalarModal as j } from "@scalar/components";
+import { isHttpMethod as D } from "@scalar/helpers/http/is-http-method";
+import { ScalarIconPencil as S } from "@scalar/icons";
+import E from "../../../../components/Sidebar/Actions/DeleteSidebarListElement.vue.js";
+import y from "../../settings/components/Section.vue.js";
+import H from "../../../components/code-input/CodeInput.vue.js";
+const L = { class: "flex flex-col gap-8" }, W = { class: "has-focus-visible:bg-b-1 group rounded-lg" }, F = {
   key: 1,
   class: "text-c-3 flex items-center justify-center rounded-lg border p-4"
-}, W = /* @__PURE__ */ g({
+}, P = { class: "flex items-center justify-between gap-4 rounded-lg p-4" }, Z = { class: "min-w-0 flex-1" }, q = { class: "bg-b-2 flex items-center justify-between gap-4 rounded-lg border border-(--scalar-background-3) p-4 text-sm" }, _ = /* @__PURE__ */ V({
   __name: "Overview",
   props: {
     documentSlug: {},
@@ -24,80 +26,180 @@ const z = { class: "has-focus-visible:bg-b-1 group rounded-lg" }, N = {
     customThemes: {},
     collectionType: {}
   },
-  setup(u) {
-    const d = x(
-      () => u.document?.info?.description ?? ""
-    ), a = y("preview"), v = w("codeInputRef"), i = async (m) => {
-      a.value = m, m === "edit" && (await h(), v.value?.focus());
+  setup(e) {
+    const x = b(() => !e.method || !e.path ? "this operation" : `${typeof e.method == "string" ? e.method.toUpperCase() : e.method} ${e.path}`), h = b(() => e.collectionType === "operation" ? !e.path || !e.method || !D(e.method) ? "" : e.document?.paths?.[e.path]?.[e.method]?.description ?? "" : e.document?.info?.description ?? ""), v = b(() => e.collectionType !== "operation" || !e.path || !D(e.method) ? !1 : e.document?.paths?.[e.path]?.[e.method]?.deprecated ?? !1), g = z("preview"), k = I("codeInputRef"), s = async (i) => {
+      g.value = i, i === "edit" && (await N(), k.value?.focus());
+    }, B = async (i) => {
+      if (await s("preview"), e.collectionType === "document")
+        return e.eventBus.emit("document:update:info", { description: i });
+      if (e.collectionType === "operation") {
+        if (!e.path || !e.method) {
+          console.error("Invalid path or method", { path: e.path, method: e.method });
+          return;
+        }
+        return e.eventBus.emit("operation:update:meta", {
+          meta: { path: e.path, method: e.method },
+          payload: {
+            description: i
+          }
+        });
+      }
+      console.error("Invalid collection type", { collectionType: e.collectionType });
+    }, $ = (i) => {
+      e.collectionType !== "operation" || !e.path || !e.method || e.eventBus.emit("operation:update:meta", {
+        meta: { path: e.path, method: e.method },
+        payload: { deprecated: i }
+      });
+    }, u = O(), M = () => {
+      e.collectionType !== "operation" || !e.path || !e.method || !e.documentSlug || (e.eventBus.emit("operation:delete:operation", {
+        documentName: e.documentSlug,
+        meta: { path: e.path, method: e.method }
+      }), u.hide());
     };
-    return (m, e) => (t(), c(I, null, {
-      title: r(() => [...e[5] || (e[5] = [
-        V("Description", -1)
-      ])]),
-      actions: r(() => [
-        a.value === "preview" ? (t(), c(o(k), {
-          key: 0,
-          class: "text-c-2 hover:text-c-1 flex items-center gap-2",
-          size: "sm",
-          type: "button",
-          variant: "outlined",
-          onClick: e[0] || (e[0] = (n) => i("edit"))
-        }, {
-          default: r(() => [
-            s(o(b), {
+    return (i, t) => (r(), d(m, null, [
+      o("div", L, [
+        a(y, null, {
+          title: l(() => [...t[5] || (t[5] = [
+            f("Description", -1)
+          ])]),
+          actions: l(() => [
+            g.value === "preview" ? (r(), T(n(p), {
+              key: 0,
+              class: "text-c-2 hover:text-c-1 flex items-center gap-2",
               size: "sm",
-              thickness: "1.5"
-            }),
-            e[6] || (e[6] = l("span", null, "Edit", -1))
+              type: "button",
+              variant: "outlined",
+              onClick: t[0] || (t[0] = (c) => s("edit"))
+            }, {
+              default: l(() => [
+                a(n(S), {
+                  size: "sm",
+                  thickness: "1.5"
+                }),
+                t[6] || (t[6] = o("span", null, "Edit", -1))
+              ]),
+              _: 1
+            })) : w("", !0)
           ]),
-          _: 1
-        })) : B("", !0)
-      ]),
-      default: r(() => [
-        l("div", z, [
-          a.value === "preview" ? (t(), p(f, { key: 0 }, [
-            d.value.trim().length ? (t(), p(f, { key: 0 }, [
-              s(o(C), {
-                class: "flex-1 rounded border border-transparent p-1.5 hover:border-(--scalar-background-3)",
-                value: d.value,
-                withImages: "",
-                onDblclick: e[1] || (e[1] = (n) => i("edit"))
-              }, null, 8, ["value"]),
-              e[7] || (e[7] = l("div", { class: "brightness-lifted bg-b-1 absolute inset-0 -z-1 hidden rounded group-hover:block group-has-focus-visible:hidden" }, null, -1))
-            ], 64)) : (t(), p("div", N, [
-              s(o(k), {
-                class: "hover:bg-b-2 hover:text-c-1 text-c-2 flex items-center gap-2",
-                size: "sm",
-                variant: "ghost",
-                onClick: e[2] || (e[2] = (n) => i("edit"))
-              }, {
-                default: r(() => [
-                  s(o(b), {
+          default: l(() => [
+            o("div", W, [
+              g.value === "preview" ? (r(), d(m, { key: 0 }, [
+                h.value.trim().length ? (r(), d(m, { key: 0 }, [
+                  a(n(R), {
+                    class: "flex-1 rounded border border-transparent p-1.5 hover:border-(--scalar-background-3)",
+                    value: h.value,
+                    withImages: "",
+                    onDblclick: t[1] || (t[1] = (c) => s("edit"))
+                  }, null, 8, ["value"]),
+                  t[7] || (t[7] = o("div", { class: "brightness-lifted bg-b-1 absolute inset-0 -z-1 hidden rounded group-hover:block group-has-focus-visible:hidden" }, null, -1))
+                ], 64)) : (r(), d("div", F, [
+                  a(n(p), {
+                    class: "hover:bg-b-2 hover:text-c-1 text-c-2 flex items-center gap-2",
                     size: "sm",
-                    thickness: "1.5"
-                  }),
-                  e[8] || (e[8] = l("span", null, "Write a description", -1))
-                ]),
-                _: 1
-              })
-            ]))
-          ], 64)) : (t(), c(o(S), {
-            key: 1,
-            ref_key: "codeInputRef",
-            ref: v,
-            class: "border px-0.5 py-0",
-            environment: void 0,
-            layout: u.layout,
-            modelValue: d.value,
-            onBlur: e[3] || (e[3] = (n) => i("preview")),
-            "onUpdate:modelValue": e[4] || (e[4] = (n) => u.eventBus.emit("document:update:info", { description: n }))
-          }, null, 8, ["layout", "modelValue"]))
-        ])
+                    variant: "ghost",
+                    onClick: t[2] || (t[2] = (c) => s("edit"))
+                  }, {
+                    default: l(() => [
+                      a(n(S), {
+                        size: "sm",
+                        thickness: "1.5"
+                      }),
+                      t[8] || (t[8] = o("span", null, "Write a description", -1))
+                    ]),
+                    _: 1
+                  })
+                ]))
+              ], 64)) : (r(), T(n(H), {
+                key: 1,
+                ref_key: "codeInputRef",
+                ref: k,
+                class: "border px-0.5 py-0",
+                environment: void 0,
+                layout: e.layout,
+                modelValue: h.value,
+                onBlur: B
+              }, null, 8, ["layout", "modelValue"]))
+            ])
+          ]),
+          _: 1
+        }),
+        e.collectionType === "operation" ? (r(), d(m, { key: 0 }, [
+          a(y, null, {
+            title: l(() => [...t[9] || (t[9] = [
+              f("Status", -1)
+            ])]),
+            default: l(() => [
+              o("div", {
+                class: C([
+                  "rounded-lg border text-sm transition-colors",
+                  v.value ? "border-(--scalar-color-alert) bg-(--scalar-background-alert)" : "bg-b-2 border-(--scalar-background-3)"
+                ])
+              }, [
+                o("div", P, [
+                  o("div", Z, [
+                    o("h4", {
+                      class: C([
+                        "font-medium",
+                        v.value ? "text-(--scalar-color-alert)" : "text-c-1"
+                      ])
+                    }, " Deprecated ", 2),
+                    t[10] || (t[10] = o("p", { class: "text-c-2 mt-1.5" }, " Mark this operation as deprecated. Consumers SHOULD refrain from using it. ", -1))
+                  ]),
+                  a(n(U), {
+                    class: "shrink-0",
+                    modelValue: v.value,
+                    "onUpdate:modelValue": $
+                  }, null, 8, ["modelValue"])
+                ])
+              ], 2)
+            ]),
+            _: 1
+          }),
+          a(y, null, {
+            title: l(() => [...t[11] || (t[11] = [
+              f("Danger Zone", -1)
+            ])]),
+            default: l(() => [
+              o("div", q, [
+                t[13] || (t[13] = o("div", { class: "min-w-0 flex-1" }, [
+                  o("h4", { class: "text-c-1 font-medium" }, "Delete Operation"),
+                  o("p", { class: "text-c-2 mt-1.5" }, " Be careful, my friend. Once deleted, there is no way to recover the operation. ")
+                ], -1)),
+                a(n(p), {
+                  class: "shrink-0",
+                  size: "sm",
+                  variant: "danger",
+                  onClick: t[3] || (t[3] = (c) => n(u).show())
+                }, {
+                  default: l(() => [...t[12] || (t[12] = [
+                    f(" Delete Operation ", -1)
+                  ])]),
+                  _: 1
+                })
+              ])
+            ]),
+            _: 1
+          })
+        ], 64)) : w("", !0)
       ]),
-      _: 1
-    }));
+      a(n(j), {
+        size: "xxs",
+        state: n(u),
+        title: `Delete ${x.value}`
+      }, {
+        default: l(() => [
+          a(E, {
+            variableName: x.value,
+            warningMessage: "This action cannot be undone.",
+            onClose: t[4] || (t[4] = (c) => n(u).hide()),
+            onDelete: M
+          }, null, 8, ["variableName"])
+        ]),
+        _: 1
+      }, 8, ["state", "title"])
+    ], 64));
   }
 });
 export {
-  W as default
+  _ as default
 };

package/dist/v2/features/collection/components/Servers.vue.d.ts

@@ -1,11 +1,11 @@
 declare const __VLS_export: import("vue").DefineComponent<(import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
-    collectionType: "document";
+    collectionType: "document" | "operation";
     document: import("@scalar/workspace-store/schemas").WorkspaceDocument;
 }) | (import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
     collectionType: "workspace";
     document: null;
 }), {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<(import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
-    collectionType: "document";
+    collectionType: "document" | "operation";
     document: import("@scalar/workspace-store/schemas").WorkspaceDocument;
 }) | (import("../../../../v2/features/app/helpers/routes.js").RouteProps & {
     collectionType: "workspace";

package/dist/v2/features/collection/components/Servers.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Servers.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/Servers.vue"],"names":[],"mappings":"AAkkBA,QAAA,MAAM,YAAY;;;;;;;;;;;;kGAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"Servers.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/collection/components/Servers.vue"],"names":[],"mappings":"AA8zBA,QAAA,MAAM,YAAY;;;;;;;;;;;;kGAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}