@scalar/api-client 2.1.26 → 2.1.27

package/dist/views/Request/RequestSidebarItemMenu.vue2.js

@@ -1,149 +1,174 @@
-import { defineComponent as h, ref as K, watch as U, onMounted as W, onBeforeUnmount as F, openBlock as s, createElementBlock as I, Fragment as k, createBlock as p, unref as n, withKeys as j, withCtx as r, createVNode as o, createElementVNode as v, createCommentVNode as N, createTextVNode as q } from "vue";
-import G from "../../components/Sidebar/Actions/DeleteSidebarListElement.vue.js";
-import H from "../../components/Sidebar/Actions/EditSidebarListCollection.vue.js";
-import J from "../../components/Sidebar/Actions/EditSidebarListElement.vue.js";
-import { PathId as x } from "../../router.js";
-import { useModal as z, ScalarDropdown as O, ScalarDropdownItem as $, ScalarIcon as w, ScalarModal as S } from "@scalar/components";
-import { useRouter as Q } from "vue-router";
-import { useWorkspace as X } from "../../store/store.js";
-const le = /* @__PURE__ */ h({
+import { defineComponent as A, ref as L, watch as P, onMounted as K, onBeforeUnmount as j, openBlock as r, createElementBlock as w, Fragment as y, createBlock as p, unref as n, withKeys as G, withCtx as u, createVNode as o, createElementVNode as g, createCommentVNode as $, createTextVNode as N, toDisplayString as H } from "vue";
+import J from "../../components/Sidebar/Actions/DeleteSidebarListElement.vue.js";
+import O from "../../components/Sidebar/Actions/EditSidebarListCollection.vue.js";
+import Q from "../../components/Sidebar/Actions/EditSidebarListElement.vue.js";
+import { PathId as b } from "../../router.js";
+import { useModal as z, ScalarDropdown as X, ScalarDropdownItem as k, ScalarIcon as v, ScalarModal as F } from "@scalar/components";
+import { useRouter as Y } from "vue-router";
+import { useWorkspace as Z } from "../../store/store.js";
+const ae = /* @__PURE__ */ A({
   __name: "RequestSidebarItemMenu",
   props: {
     menuItem: {}
   },
-  emits: ["closeMenu"],
-  setup(b, { emit: B }) {
-    const a = b, T = B, { replace: y } = Q(), { activeWorkspace: E, activeRouterParams: g, events: V } = X(), u = z(), d = z(), A = () => {
+  emits: ["closeMenu", "toggleWatchForChanges"],
+  setup(S, { emit: q }) {
+    const a = S, h = q, { replace: C } = Y(), { activeWorkspace: E, activeRouterParams: M, events: x } = Z(), d = z(), I = z(), B = () => {
       var e;
-      return V.commandPalette.emit({
+      return x.commandPalette.emit({
         commandName: "Add Example",
         metaData: {
           itemUid: (e = a.menuItem.item) == null ? void 0 : e.entity.uid
         }
       });
-    }, C = (e, t) => {
+    }, R = (e, t) => {
       var m;
-      (m = a.menuItem.item) == null || m.edit(e, t), u.hide();
-    }, L = () => {
+      (m = a.menuItem.item) == null || m.edit(e, t), d.hide();
+    }, T = () => {
       var e, t, m;
-      (e = a.menuItem.item) == null || e.delete(), g.value[x.Request] === ((t = a.menuItem.item) == null ? void 0 : t.entity.uid) && y(`/workspace/${E.value.uid}/request/default`), g.value[x.Examples] === ((m = a.menuItem.item) == null ? void 0 : m.entity.uid) && y(`/workspace/${E.value}/request/default`), d.hide();
-    }, f = K(null);
-    U([() => a.menuItem.open, f], async ([e]) => {
+      (e = a.menuItem.item) == null || e.delete(), M.value[b.Request] === ((t = a.menuItem.item) == null ? void 0 : t.entity.uid) && C(`/workspace/${E.value.uid}/request/default`), M.value[b.Examples] === ((m = a.menuItem.item) == null ? void 0 : m.entity.uid) && C(`/workspace/${E.value}/request/default`), I.hide();
+    }, f = L(null);
+    P([() => a.menuItem.open, f], async ([e]) => {
       var t, m;
       e && ((m = (t = f.value) == null ? void 0 : t.$parent) != null && m.$el) && f.value.$parent.$el.focus();
     });
-    const M = () => a.menuItem.open && T("closeMenu");
-    return W(() => window.addEventListener("click", M)), F(() => window.removeEventListener("click", M)), (e, t) => {
-      var m, R;
-      return s(), I(k, null, [
-        e.menuItem.targetRef && e.menuItem.open ? (s(), p(n(O), {
+    const D = () => a.menuItem.open && h("closeMenu");
+    K(() => window.addEventListener("click", D)), j(() => window.removeEventListener("click", D));
+    const U = () => {
+      h("toggleWatchForChanges", a.menuItem.item);
+    };
+    return (e, t) => {
+      var m, W;
+      return r(), w(y, null, [
+        e.menuItem.targetRef && e.menuItem.open ? (r(), p(n(X), {
           key: 0,
           static: "",
           targetRef: e.menuItem.targetRef,
           teleport: "",
-          onKeydown: t[2] || (t[2] = j((l) => e.$emit("closeMenu"), ["escape"]))
+          onKeydown: t[2] || (t[2] = G((l) => e.$emit("closeMenu"), ["escape"]))
         }, {
-          items: r(() => {
-            var l;
+          items: u(() => {
+            var l, s;
             return [
-              ((l = e.menuItem.item) == null ? void 0 : l.entity.type) === "request" ? (s(), p(n($), {
+              ((l = e.menuItem.item) == null ? void 0 : l.entity.type) === "request" ? (r(), p(n(k), {
                 key: 0,
                 class: "flex gap-2",
-                onClick: A
+                onClick: B
               }, {
-                default: r(() => [
-                  o(n(w), {
+                default: u(() => [
+                  o(n(v), {
                     class: "inline-flex",
                     icon: "Example",
                     size: "md",
                     thickness: "1.5"
                   }),
-                  t[6] || (t[6] = v("span", null, "Add Example", -1))
+                  t[6] || (t[6] = g("span", null, "Add Example", -1))
                 ]),
                 _: 1
-              })) : N("", !0),
-              o(n($), {
+              })) : $("", !0),
+              o(n(k), {
                 ref_key: "menuRef",
                 ref: f,
                 class: "flex gap-2",
-                onClick: t[0] || (t[0] = (i) => n(u).show())
+                onClick: t[0] || (t[0] = (i) => n(d).show())
               }, {
-                default: r(() => {
+                default: u(() => {
                   var i;
                   return [
-                    o(n(w), {
+                    o(n(v), {
                       class: "inline-flex",
                       icon: "Edit",
                       size: "md",
                       thickness: "1.5"
                     }),
-                    v("span", null, [
-                      ((i = e.menuItem.item) == null ? void 0 : i.entity.type) === "collection" ? (s(), I(k, { key: 0 }, [
-                        q(" Edit ")
-                      ], 64)) : (s(), I(k, { key: 1 }, [
-                        q(" Rename ")
+                    g("span", null, [
+                      ((i = e.menuItem.item) == null ? void 0 : i.entity.type) === "collection" ? (r(), w(y, { key: 0 }, [
+                        N(" Edit ")
+                      ], 64)) : (r(), w(y, { key: 1 }, [
+                        N(" Rename ")
                       ], 64))
                     ])
                   ];
                 }),
                 _: 1
               }, 512),
-              o(n($), {
+              (s = e.menuItem.item) != null && s.documentUrl ? (r(), p(n(k), {
+                key: 1,
+                ref_key: "menuRef",
+                ref: f,
                 class: "flex gap-2",
-                onClick: t[1] || (t[1] = (i) => n(d).show())
+                onClick: U
               }, {
-                default: r(() => [
-                  o(n(w), {
+                default: u(() => {
+                  var i, c;
+                  return [
+                    o(n(v), {
+                      class: "inline-flex",
+                      icon: (i = e.menuItem.item) != null && i.watchForChanges ? "Unwatch" : "Watch",
+                      size: "md",
+                      thickness: "1.5"
+                    }, null, 8, ["icon"]),
+                    g("span", null, H((c = e.menuItem.item) != null && c.watchForChanges ? "Disable Watch Mode" : "Enable Watch Mode"), 1)
+                  ];
+                }),
+                _: 1
+              }, 512)) : $("", !0),
+              o(n(k), {
+                class: "flex gap-2",
+                onClick: t[1] || (t[1] = (i) => n(I).show())
+              }, {
+                default: u(() => [
+                  o(n(v), {
                     class: "inline-flex",
                     icon: "Delete",
                     size: "md",
                     thickness: "1.5"
                   }),
-                  t[7] || (t[7] = v("span", null, "Delete", -1))
+                  t[7] || (t[7] = g("span", null, "Delete", -1))
                 ]),
                 _: 1
               })
             ];
           }),
           _: 1
-        }, 8, ["targetRef"])) : N("", !0),
-        o(n(S), {
+        }, 8, ["targetRef"])) : $("", !0),
+        o(n(F), {
           size: "xxs",
-          state: n(d),
+          state: n(I),
           title: `Delete ${(m = e.menuItem.item) == null ? void 0 : m.resourceTitle}`
         }, {
-          default: r(() => {
-            var l, i;
+          default: u(() => {
+            var l, s;
             return [
-              o(G, {
+              o(J, {
                 variableName: ((l = e.menuItem.item) == null ? void 0 : l.title) ?? "",
-                warningMessage: (i = e.menuItem.item) == null ? void 0 : i.warning,
-                onClose: t[3] || (t[3] = (c) => n(d).hide()),
-                onDelete: L
+                warningMessage: (s = e.menuItem.item) == null ? void 0 : s.warning,
+                onClose: t[3] || (t[3] = (i) => n(I).hide()),
+                onDelete: T
               }, null, 8, ["variableName", "warningMessage"])
             ];
           }),
           _: 1
         }, 8, ["state", "title"]),
-        o(n(S), {
+        o(n(F), {
           size: "xxs",
-          state: n(u),
-          title: `Edit ${(R = e.menuItem.item) == null ? void 0 : R.resourceTitle}`
+          state: n(d),
+          title: `Edit ${(W = e.menuItem.item) == null ? void 0 : W.resourceTitle}`
         }, {
-          default: r(() => {
-            var l, i, c, D;
+          default: u(() => {
+            var l, s, i, c;
             return [
-              ((l = e.menuItem.item) == null ? void 0 : l.resourceTitle) === "Collection" ? (s(), p(H, {
+              ((l = e.menuItem.item) == null ? void 0 : l.resourceTitle) === "Collection" ? (r(), p(O, {
                 key: 0,
-                icon: ((i = e.menuItem.item) == null ? void 0 : i.icon) || "interface-content-folder",
-                name: (c = e.menuItem.item) == null ? void 0 : c.title,
-                onClose: t[4] || (t[4] = (P) => n(u).hide()),
-                onEdit: C
-              }, null, 8, ["icon", "name"])) : (s(), p(J, {
+                icon: ((s = e.menuItem.item) == null ? void 0 : s.icon) || "interface-content-folder",
+                name: (i = e.menuItem.item) == null ? void 0 : i.title,
+                onClose: t[4] || (t[4] = (V) => n(d).hide()),
+                onEdit: R
+              }, null, 8, ["icon", "name"])) : (r(), p(Q, {
                 key: 1,
-                name: ((D = e.menuItem.item) == null ? void 0 : D.title) ?? "",
-                onClose: t[5] || (t[5] = (P) => n(u).hide()),
-                onEdit: C
+                name: ((c = e.menuItem.item) == null ? void 0 : c.title) ?? "",
+                onClose: t[5] || (t[5] = (V) => n(d).hide()),
+                onEdit: R
               }, null, 8, ["name"]))
             ];
           }),
@@ -154,5 +179,5 @@ const le = /* @__PURE__ */ h({
   }
 });
 export {
-  le as default
+  ae as default
 };

package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js

@@ -13,7 +13,7 @@ const N = { class: "relative col-1 flex-center gap-6 p-2 capitalize" }, q = { cl
       s.commandPalette.emit({ commandName: "Create Request" });
     }, c = (n) => {
       n != null && n.openCommandPaletteRequest && m();
-    }, x = "2.1.26";
+    }, x = "2.1.27";
     return k(() => s.hotKeys.on(c)), R(() => s.hotKeys.off(c)), (n, e) => (r(), l("div", N, [
       t("div", q, [
         o(f).isReadOnly ? p("", !0) : (r(), l("div", v, [

package/dist/views/Request/hooks/useOpenApiWatcher.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hook which handles polling the documentUrl for changes then attempts to merge what is new
+ *
+ * TODO:
+ * - check lastModified or similar headers
+ * - speed up the polling when there's a change then slowly slow it down
+ */
+export declare const useOpenApiWatcher: () => void;
+//# sourceMappingURL=useOpenApiWatcher.d.ts.map

package/dist/views/Request/hooks/useOpenApiWatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOpenApiWatcher.d.ts","sourceRoot":"","sources":["../../../../src/views/Request/hooks/useOpenApiWatcher.ts"],"names":[],"mappings":"AAuBA;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,YAyI7B,CAAA"}

package/dist/views/Request/hooks/useOpenApiWatcher.js

@@ -0,0 +1,86 @@
+import { specDictionary as u } from "../../../store/import-spec.js";
+import { combineRenameDiffs as y, mutateCollectionDiff as A, mutateSecuritySchemeDiff as R, mutateServerDiff as S, mutateTagDiff as D, mutateRequestDiff as E } from "../libs/live-sync.js";
+import { fetchSpecFromUrl as C, createHash as T } from "@scalar/oas-utils/helpers";
+import { parseSchema as l } from "@scalar/oas-utils/transforms";
+import { useToasts as d } from "@scalar/use-toasts";
+import { useTimeoutPoll as F } from "@vueuse/core";
+import I from "microdiff";
+import { watch as U } from "vue";
+import { useWorkspace as L } from "../../../store/store.js";
+const N = 5 * 1e3, b = 60 * 1e3, V = () => {
+  const { toast: h } = d(), c = L(), { activeCollection: t, activeWorkspace: g, collectionMutators: i } = c, o = (e) => h(
+    `[useOpenApiWatcher] Changes to the ${e} were not applied`,
+    "error"
+  ), v = (e) => {
+    e.path[0] === "info" || e.path[0] === "security" ? A(e, c) || o("collection") : e.path[0] === "components" && e.path[1] === "securitySchemes" ? R(e, c) || o("securitySchemes") : e.path[0] === "servers" ? S(e, c) || o("servers") : e.path[0] === "tags" ? D(e, c) || o("tags") : e.path[0] === "paths" && (E(e, c) || o("requests"));
+  }, { pause: f, resume: p } = F(async () => {
+    var m;
+    const e = (m = t.value) == null ? void 0 : m.documentUrl;
+    if (!e) return;
+    const s = u[e];
+    try {
+      const r = await C(
+        e,
+        g.value.proxyUrl,
+        !1
+      ), n = T(r);
+      if (i.edit(
+        t.value.uid,
+        "watchForChangesStatus",
+        "WATCHING"
+      ), s != null && s.hash)
+        if (s.hash && s.hash !== n) {
+          const { schema: a } = await l(r), O = I(s.schema, a), W = y(O);
+          try {
+            W.forEach(v), u[e] = {
+              hash: n,
+              schema: a
+            };
+          } catch (w) {
+            console.error("[useOpenApiWatcher] Error:", w);
+          }
+        } else console.log("[useOpenApiWatcher] No changes detected yet…");
+      else {
+        const { schema: a } = await l(r);
+        a && (u[e] = {
+          hash: n,
+          schema: a
+        });
+      }
+    } catch (r) {
+      console.error("[useOpenApiWatcher] Error:", r), console.info("[useOpenApiWatcher] Pausing watcher for 60 seconds"), f(), i.edit(
+        t.value.uid,
+        "watchForChangesStatus",
+        "ERROR"
+      ), h(
+        "[useOpenApiWatcher] Unable to fetch the spec file, paused the watcher for 60 seconds",
+        "error"
+      ), setTimeout(() => {
+        console.info("[useOpenApiWatcher] Resuming watcher"), p();
+      }, b);
+    }
+  }, N);
+  U(
+    [
+      () => {
+        var e;
+        return (e = t.value) == null ? void 0 : e.documentUrl;
+      },
+      () => {
+        var e;
+        return (e = t.value) == null ? void 0 : e.watchForChanges;
+      }
+    ],
+    ([e, s]) => {
+      e && s ? (console.info(`[useOpenApiWatcher] Watching ${e} …`), p()) : t.value && (f(), i.edit(
+        t.value.uid,
+        "watchForChangesStatus",
+        "IDLE"
+      ));
+    },
+    { immediate: !0 }
+  );
+};
+export {
+  V as useOpenApiWatcher
+};

package/dist/views/Request/libs/live-sync.d.ts

@@ -0,0 +1,59 @@
+import type { WorkspaceStore } from '../../../store/index.js';
+import { type Path, type PathValue } from '@scalar/object-utils/nested';
+import { type Difference } from 'microdiff';
+import { type ZodSchema, type ZodTypeDef } from 'zod';
+/**
+ * Combine Rename Diffs
+ * Rename diffs show up as a delete and an add.
+ * This will go through the diff and combine any diff items which are next to each other which go from remove to add.
+ *
+ * - first we check if the payloads are the same then it was just a simple rename
+ * - next we will add the rename and also handle any changes in the diff
+ */
+export declare const combineRenameDiffs: (diff: Difference[], pathPrefix?: string[]) => Difference[];
+/** Like array.find but returns the resource instead of the uid */
+export declare const findResource: <T>(arr: string[], resources: Record<string, T>, condition: (resource: T) => boolean) => T | null;
+/**
+ * Traverses a zod schema based on the path and returns the schema at the end of the path
+ * or null if the path doesn't exist. Handles optional unwrapping, records, and arrays
+ */
+export declare const traverseZodSchema: (schema: ZodSchema, path: (string | number)[]) => ZodSchema | null;
+/**
+ * Takes in diff, uses the path to get to the nested schema then parse the value
+ * If there is a sub schema and it successfully parses, both the path and new value are valid and returned as such
+ *
+ * We return a tuple to make it easier to pass into the mutators
+ */
+export declare const parseDiff: <T>(schema: ZodSchema<T, ZodTypeDef, any>, diff: Difference) => {
+    /** Typed path as it has been checked agains the schema */
+    path: Path<T>;
+    /** Path without the last item, used for getting the whole array instead of an item of the array */
+    pathMinusOne: Path<T>;
+    /** Typed value which has been parsed against the schema */
+    value: PathValue<T, Path<T>> | undefined;
+} | null;
+/**
+ * Transforms the diff into a payload for the collection mutator then executes that mutation
+ *
+ * @returns true if it succeeds, and false for a failure
+ */
+export declare const mutateCollectionDiff: (diff: Difference, { activeCollection, collectionMutators }: WorkspaceStore) => boolean;
+/**
+ * Generates an array of payloads for the request mutator from the request diff, also executes the mutation
+ */
+export declare const mutateRequestDiff: (diff: Difference, store: WorkspaceStore) => boolean;
+/** Generates a payload for the server mutator from the server diff including the mutator method */
+export declare const mutateServerDiff: (diff: Difference, { activeCollection, servers, serverMutators }: WorkspaceStore) => boolean;
+/** Generates a payload for the tag mutator from the tag diff */
+export declare const mutateTagDiff: (diff: Difference, { activeCollection, tags, tagMutators }: WorkspaceStore) => boolean;
+/** Narrows down a zod union schema */
+export declare const narrowUnionSchema: (schema: ZodSchema, key: string, value: string) => ZodSchema | null;
+/**
+ * Generates a payload for the security scheme mutator from the security scheme diff, then executes that mutation
+ *
+ * Note: for edit we cannot use parseDiff here as it can't do unions, so we handle the unions first
+ *
+ * @returns true if it succeeds, and false for a failure
+ */
+export declare const mutateSecuritySchemeDiff: (diff: Difference, { activeCollection, securitySchemes, securitySchemeMutators }: WorkspaceStore) => boolean;
+//# sourceMappingURL=live-sync.d.ts.map

package/dist/views/Request/libs/live-sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"live-sync.d.ts","sourceRoot":"","sources":["../../../../src/views/Request/libs/live-sync.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAgB7C,OAAO,EACL,KAAK,IAAI,EACT,KAAK,SAAS,EAEf,MAAM,6BAA6B,CAAA;AAEpC,OAAkB,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAK,MAAM,KAAK,CAAA;AAExD;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,SACvB,UAAU,EAAE,eACN,MAAM,EAAE,KACnB,UAAU,EAqFZ,CAAA;AAED,kEAAkE;AAClE,eAAO,MAAM,YAAY,GAAI,CAAC,OACvB,MAAM,EAAE,aACF,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,aACjB,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,KAClC,CAAC,GAAG,IAMN,CAAA;AASD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,WACpB,SAAS,QACX,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KACxB,SAAS,GAAG,IAqDd,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,UACjB,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,QAC/B,UAAU,KACf;IACD,0DAA0D;IAC1D,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IACb,mGAAmG;IACnG,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IACrB,2DAA2D;IAC3D,KAAK,EAAE,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAA;CACzC,GAAG,IAwBH,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,SACzB,UAAU,4CAC0B,cAAc,KACvD,OA0CF,CAAA;AAwBD;;GAEG;AACH,eAAO,MAAM,iBAAiB,SACtB,UAAU,SACT,cAAc,KACpB,OAwIF,CAAA;AAED,mGAAmG;AACnG,eAAO,MAAM,gBAAgB,SACrB,UAAU,iDAC+B,cAAc,KAC5D,OAoCF,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,aAAa,SAClB,UAAU,2CACyB,cAAc,KACtD,OA+BF,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,iBAAiB,WACpB,SAAS,OACZ,MAAM,SACJ,MAAM,KACZ,SAAS,GAAG,IAmBd,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,SAC7B,UAAU,iEAC+C,cAAc,KAC5E,OA+EF,CAAA"}