@scalar/api-client 2.2.28 → 2.2.30

package/dist/store/active-entities.d.ts

@@ -1,7 +1,7 @@
 import type { Environment } from '@scalar/oas-utils/entities/environment';
 import type { Collection, Request, RequestExample, Server } from '@scalar/oas-utils/entities/spec';
 import type { Workspace } from '@scalar/oas-utils/entities/workspace';
-import { type InjectionKey } from 'vue';
+import { type ComputedRef, type InjectionKey } from 'vue';
 import type { Router } from 'vue-router';
 type CreateActiveEntitiesStoreParams = {
     collections: Record<string, Collection>;
@@ -11,6 +11,10 @@ type CreateActiveEntitiesStoreParams = {
     servers: Record<string, Server>;
     workspaces: Record<string, Workspace>;
     router?: Router;
+    /** Override the active request  */
+    activeRequestOverride?: ComputedRef<Request | undefined>;
+    /** Override the active request example  */
+    activeExampleOverride?: ComputedRef<RequestExample | undefined>;
 };
 type EnvVariable = {
     key: string;
@@ -22,8 +26,8 @@ type EnvVariable = {
  *
  * We need the factory function to pass the router instance
  */
-export declare const createActiveEntitiesStore: ({ collections, requestExamples, requests, router, servers, workspaces, }: CreateActiveEntitiesStoreParams) => {
-    activeCollection: import("vue").ComputedRef<{
+export declare const createActiveEntitiesStore: ({ collections, requestExamples, requests, router, servers, workspaces, activeRequestOverride, activeExampleOverride, }: CreateActiveEntitiesStoreParams) => {
+    activeCollection: ComputedRef<{
         type: "collection";
         uid: string;
         children: string[];
@@ -78,8 +82,8 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         documentUrl?: string | undefined;
         integration?: string | null | undefined;
     } | undefined>;
-    activeCookieId: import("vue").ComputedRef<string | undefined>;
-    activeExample: import("vue").ComputedRef<{
+    activeCookieId: ComputedRef<string>;
+    activeExample: ComputedRef<{
         type: "requestExample";
         uid: string;
         name: string;
@@ -174,7 +178,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         };
         serverVariables?: Record<string, string[]> | undefined;
     } | undefined>;
-    activeRequest: import("vue").ComputedRef<{
+    activeRequest: ComputedRef<{
         path: string;
         type: "request";
         uid: string;
@@ -211,7 +215,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         requestBody?: any;
         responses?: Record<string, any> | undefined;
     } | undefined>;
-    activeRouterParams: import("vue").ComputedRef<{
+    activeRouterParams: ComputedRef<{
         collection: string;
         environment: string;
         request: string;
@@ -222,7 +226,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         workspace: string;
         settings: string;
     }>;
-    activeEnvironment: import("vue").ComputedRef<{
+    activeEnvironment: ComputedRef<{
         uid: string;
         color: string;
         name: string;
@@ -235,7 +239,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         color: string;
         isDefault: boolean;
     }>;
-    activeServer: import("vue").ComputedRef<{
+    activeServer: ComputedRef<{
         uid: string;
         url: string;
         description?: string | undefined;
@@ -243,7 +247,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
             enum?: [string, ...string[]];
         }> | undefined;
     } | undefined>;
-    activeWorkspace: import("vue").ComputedRef<{
+    activeWorkspace: ComputedRef<{
         uid: string;
         name: string;
         description: string;
@@ -261,7 +265,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         } | undefined;
         proxyUrl?: string | undefined;
     } | undefined>;
-    activeWorkspaceCollections: import("vue").ComputedRef<{
+    activeWorkspaceCollections: ComputedRef<{
         type: "collection";
         uid: string;
         children: string[];
@@ -316,7 +320,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         documentUrl?: string | undefined;
         integration?: string | null | undefined;
     }[]>;
-    activeWorkspaceServers: import("vue").ComputedRef<({
+    activeWorkspaceServers: ComputedRef<({
         uid: string;
         url: string;
         description?: string | undefined;
@@ -324,8 +328,8 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
             enum?: [string, ...string[]];
         }> | undefined;
     } | undefined)[]>;
-    activeEnvVariables: import("vue").ComputedRef<EnvVariable[]>;
-    activeWorkspaceRequests: import("vue").ComputedRef<string[]>;
+    activeEnvVariables: ComputedRef<EnvVariable[]>;
+    activeWorkspaceRequests: ComputedRef<string[]>;
 };
 export type ActiveEntitiesStore = ReturnType<typeof createActiveEntitiesStore>;
 export declare const ACTIVE_ENTITIES_SYMBOL: InjectionKey<ActiveEntitiesStore>;

package/dist/store/active-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,cAAc,EACd,MAAM,EACP,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6EAOnC,+BAA+B;;;;;;;;;;;;;;;;;;uBA6N8mW,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAAkX,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;oBAA49S,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAA6C,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;+BAAkD,CAAC;wBAA0C,CAAC;0BAA8C,CAAC;wBAA0C,CAAC;4BAA+B,CAAC;;;;kBAA+H,CAAC;eAA+B,CAAC;;;;;;;;;;;uBAAoT,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;;;;;;;;;;;;;uBAAt3Q,CAAC;;;;;;;;;;;uBAAqX,CAAC;mBAAqC,CAAC;kBAAyB,CAAC;mBAA0B,CAAC;iBAAwB,CAAC;oBAA0H,CAAC;qBAAoC,CAAC;uBAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA5JryhB,CAAC;;;;;;;;;;;;;;mBA4J4kB,CAAC;;yBAAq4B,CAAC;;;;;;;;;;;;;;;;;;;;;;uBAAsqT,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAAkX,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;gBA5JhvY,CAAC;;;;;CA2ItB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC9E,eAAO,MAAM,sBAAsB,EACrB,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAAO,mBAIpC,CAAA"}
+{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,cAAc,EACd,MAAM,EACP,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,qBAAqB,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACxD,2CAA2C;IAC3C,qBAAqB,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;CAChE,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,2HAUnC,+BAA+B;;;;;;;;;;;;;;;;;;uBAiOivV,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAAkX,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;oBAA49S,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAA6C,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;+BAAkD,CAAC;wBAA0C,CAAC;0BAA8C,CAAC;wBAA0C,CAAC;4BAA+B,CAAC;;;;kBAA+H,CAAC;eAA+B,CAAC;;;;;;;;;;;uBAAoT,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAyC,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;;;;;;;;;;;;;uBAAt3Q,CAAC;;;;;;;;;;;uBAAqX,CAAC;mBAAqC,CAAC;kBAAyB,CAAC;mBAA0B,CAAC;iBAAwB,CAAC;oBAA0H,CAAC;qBAAoC,CAAC;uBAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA7Kj5gB,CAAC;;;;;;;;;;;;;;mBA6KwL,CAAC;;yBAAq4B,CAAC;;;;;;;;;;;;;;;;;;;;;;uBAAsqT,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAAkX,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;gBA7K51X,CAAC;;;;;CA4J7C,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC9E,eAAO,MAAM,sBAAsB,EACrB,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAAO,mBAIpC,CAAA"}

package/dist/store/active-entities.js

@@ -1,32 +1,35 @@
 import { flattenEnvVars as D } from "../libs/string-template.js";
-import { isDefined as M } from "@scalar/oas-utils/helpers";
-import { computed as i, inject as U } from "vue";
-import { getRouterParams as j } from "./router-params.js";
+import { isDefined as j } from "@scalar/oas-utils/helpers";
+import { computed as i, inject as w } from "vue";
+import { getRouterParams as P } from "./router-params.js";
 import { PathId as m } from "../routes.js";
-const L = ({
+const z = ({
   collections: v,
   requestExamples: N,
   requests: I,
   router: O,
   servers: S,
-  workspaces: E
+  workspaces: E,
+  // TODO: these are temporary until we allow providing each entity individually
+  activeRequestOverride: q,
+  activeExampleOverride: C
 }) => {
-  const l = i(j(O)), a = i(() => E[l.value[m.Workspace]] ?? E[Object.keys(E)[0] ?? ""]), f = i(
+  const l = i(P(O)), a = i(() => E[l.value[m.Workspace]] ?? E[Object.keys(E)[0] ?? ""]), f = i(
     () => {
       var e;
-      return ((e = a.value) == null ? void 0 : e.collections.map((t) => v[t]).filter(M).sort((t, n) => {
+      return ((e = a.value) == null ? void 0 : e.collections.map((t) => v[t]).filter(j).sort((t, n) => {
         var s, o;
         return ((s = t.info) == null ? void 0 : s.title) === "Drafts" ? 1 : ((o = n.info) == null ? void 0 : o.title) === "Drafts" ? -1 : 0;
       })) ?? [];
     }
-  ), q = i(
+  ), h = i(
     () => {
       var e;
       return (e = f.value) == null ? void 0 : e.flatMap(
         (t) => t.servers.map((n) => S[n])
       );
     }
-  ), C = i(
+  ), A = i(
     () => {
       var e;
       return ((e = f.value) == null ? void 0 : e.flatMap(
@@ -43,9 +46,9 @@ const L = ({
         value: JSON.stringify((n = a.value) == null ? void 0 : n.environments, null, 2)
       };
     const e = f.value.find(
-      (J) => {
+      (U) => {
         var g, x;
-        return (x = J["x-scalar-environments"]) == null ? void 0 : x[((g = a.value) == null ? void 0 : g.activeEnvironmentId) ?? ""];
+        return (x = U["x-scalar-environments"]) == null ? void 0 : x[((g = a.value) == null ? void 0 : g.activeEnvironmentId) ?? ""];
       }
     );
     return e && ((s = a.value) != null && s.activeEnvironmentId) ? {
@@ -64,11 +67,11 @@ const L = ({
       name: "No Environment",
       value: JSON.stringify(a.value.environments, null, 2)
     };
-  }), d = i(() => {
+  }), d = q ?? i(() => {
     var n;
     const e = l.value[m.Request], t = v[l.value.collection] || v[((n = a.value) == null ? void 0 : n.collections[0]) ?? ""];
     return I[e] || I[(t == null ? void 0 : t.requests[0]) ?? ""];
-  }), h = i(() => {
+  }), R = C ?? i(() => {
     var t;
     const e = l.value[m.Examples] === "default" ? ((t = d.value) == null ? void 0 : t.examples[0]) || "" : l.value[m.Examples];
     return N[e];
@@ -84,14 +87,14 @@ const L = ({
       );
     const t = ((s = a.value) == null ? void 0 : s.collections[0]) ?? ((o = v[0]) == null ? void 0 : o.uid) ?? "";
     return v[t];
-  }), A = i(
+  }), W = i(
     () => {
       var e, t, n;
       return S[(((e = d.value) == null ? void 0 : e.selectedServerUid) || ((t = k.value) == null ? void 0 : t.selectedServerUid) || ((n = k.value) == null ? void 0 : n.servers[0])) ?? ""];
     }
-  ), R = i(
+  ), J = i(
     () => l.value[m.Cookies]
-  ), W = i(() => {
+  ), M = i(() => {
     var c;
     const e = ((c = a.value) == null ? void 0 : c.environments) ?? {}, t = p.value.uid ? JSON.parse(p.value.value) : {}, n = D(e).map(
       ([r, u]) => ({
@@ -114,25 +117,25 @@ const L = ({
   });
   return {
     activeCollection: k,
-    activeCookieId: R,
-    activeExample: h,
+    activeCookieId: J,
+    activeExample: R,
     activeRequest: d,
     activeRouterParams: l,
     activeEnvironment: p,
-    activeServer: A,
+    activeServer: W,
     activeWorkspace: a,
     activeWorkspaceCollections: f,
-    activeWorkspaceServers: q,
-    activeEnvVariables: W,
-    activeWorkspaceRequests: C
+    activeWorkspaceServers: h,
+    activeEnvVariables: M,
+    activeWorkspaceRequests: A
   };
-}, w = Symbol(), Y = () => {
-  const v = U(w);
+}, T = Symbol(), F = () => {
+  const v = w(T);
   if (!v) throw new Error("Active entities store not provided");
   return v;
 };
 export {
-  w as ACTIVE_ENTITIES_SYMBOL,
-  L as createActiveEntitiesStore,
-  Y as useActiveEntities
+  T as ACTIVE_ENTITIES_SYMBOL,
+  z as createActiveEntitiesStore,
+  F as useActiveEntities
 };