@scalar/api-client 2.1.51 → 2.2.0

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

@@ -0,0 +1,333 @@
+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 { Router } from 'vue-router';
+type CreateActiveEntitiesStoreParams = {
+    router: Router;
+    collections: Record<string, Collection>;
+    environments: Record<string, Environment>;
+    requestExamples: Record<string, RequestExample>;
+    requests: Record<string, Request>;
+    servers: Record<string, Server>;
+    workspaces: Record<string, Workspace>;
+};
+/**
+ * Create the active entities store
+ *
+ * We need the factory function to pass the router instance
+ */
+export declare const createActiveEntitiesStore: ({ collections, environments, requestExamples, requests, router, servers, workspaces, }: CreateActiveEntitiesStoreParams) => {
+    activeCollection: import("vue").ComputedRef<{
+        type: "collection";
+        uid: string;
+        children: string[];
+        openapi: string;
+        security: Record<string, string[]>[];
+        'x-scalar-icon': string;
+        securitySchemes: string[];
+        selectedSecuritySchemeUids: string[];
+        selectedServerUid: string;
+        servers: string[];
+        requests: string[];
+        tags: string[];
+        watchMode: boolean;
+        watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
+        externalDocs?: {
+            url: string;
+            description?: string | undefined;
+        } | undefined;
+        jsonSchemaDialect?: string | undefined;
+        info?: {
+            title: string;
+            version: string;
+            description?: string | undefined;
+            summary?: string | undefined;
+            termsOfService?: string | undefined;
+            contact?: {
+                name?: string | undefined;
+                url?: string | undefined;
+                email?: string | undefined;
+            } | undefined;
+            license?: {
+                name: string;
+                identifier?: string | undefined;
+                url?: string | undefined;
+            } | undefined;
+        } | undefined;
+        components?: Record<string, unknown> | undefined;
+        webhooks?: Record<string, unknown> | undefined;
+        'x-scalar-environment'?: string | undefined;
+        'x-scalar-environments'?: Record<string, {
+            variables: Record<string, string | {
+                default: string;
+                description?: string | undefined;
+            }>;
+            description?: string | undefined;
+            color?: string | undefined;
+        }> | undefined;
+        'x-scalar-secrets'?: Record<string, {
+            description?: string | undefined;
+            example?: string | undefined;
+        }> | undefined;
+        documentUrl?: string | undefined;
+        integration?: string | null | undefined;
+    } | undefined>;
+    activeCookieId: import("vue").ComputedRef<string | undefined>;
+    activeExample: import("vue").ComputedRef<{
+        type: "requestExample";
+        uid: string;
+        name: string;
+        body: {
+            activeBody: "formData" | "binary" | "raw";
+            formData?: {
+                value: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    nullable?: boolean | undefined;
+                }[];
+                encoding: "form-data" | "urlencoded";
+            } | undefined;
+            binary?: Blob | undefined;
+            raw?: {
+                value: string;
+                encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+            } | undefined;
+        };
+        requestUid: string;
+        parameters: {
+            path: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                nullable?: boolean | undefined;
+            }[];
+            cookies: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                nullable?: boolean | undefined;
+            }[];
+            query: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                nullable?: boolean | undefined;
+            }[];
+            headers: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                nullable?: boolean | undefined;
+            }[];
+        };
+        serverVariables?: Record<string, string[]> | undefined;
+    } | undefined>;
+    activeRequest: import("vue").ComputedRef<{
+        path: string;
+        type: "request";
+        uid: string;
+        selectedSecuritySchemeUids: string[];
+        selectedServerUid: string;
+        servers: string[];
+        examples: string[];
+        method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
+        description?: string | undefined;
+        summary?: string | undefined;
+        externalDocs?: {
+            url: string;
+            description?: string | undefined;
+        } | undefined;
+        security?: Record<string, string[]>[] | undefined;
+        tags?: string[] | undefined;
+        deprecated?: boolean | undefined;
+        operationId?: string | undefined;
+        parameters?: {
+            required: boolean;
+            name: string;
+            in: "path" | "query" | "header" | "cookie";
+            deprecated: boolean;
+            description?: string | undefined;
+            example?: unknown;
+            schema?: unknown;
+            content?: unknown;
+            style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+            examples?: Record<string, {
+                value?: unknown;
+                summary?: string | undefined;
+            }> | undefined;
+        }[] | undefined;
+        requestBody?: any;
+        responses?: Record<string, any> | undefined;
+    } | undefined>;
+    activeRouterParams: import("vue").ComputedRef<{
+        collection: string;
+        environment: string;
+        request: string;
+        examples: string;
+        schema: string;
+        cookies: string;
+        servers: string;
+        workspace: string;
+        settings: string;
+    }>;
+    activeEnvironment: import("vue").ComputedRef<{
+        value: string;
+        uid: string;
+        name: string;
+        color: string;
+        isDefault?: boolean | undefined;
+    }>;
+    activeServer: import("vue").ComputedRef<{
+        uid: string;
+        url: string;
+        description?: string | undefined;
+        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+            enum?: [string, ...string[]];
+        }> | undefined;
+    }>;
+    activeWorkspace: import("vue").ComputedRef<{
+        uid: string;
+        name: string;
+        description: string;
+        collections: string[];
+        environments: string[];
+        activeEnvironmentId: string;
+        cookies: string[];
+        themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
+        hotKeyConfig?: {
+            modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
+            hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
+                event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
+                modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
+            }>> | undefined;
+        } | undefined;
+        proxyUrl?: string | undefined;
+    }>;
+    activeWorkspaceCollections: import("vue").ComputedRef<{
+        type: "collection";
+        uid: string;
+        children: string[];
+        openapi: string;
+        security: Record<string, string[]>[];
+        'x-scalar-icon': string;
+        securitySchemes: string[];
+        selectedSecuritySchemeUids: string[];
+        selectedServerUid: string;
+        servers: string[];
+        requests: string[];
+        tags: string[];
+        watchMode: boolean;
+        watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
+        externalDocs?: {
+            url: string;
+            description?: string | undefined;
+        } | undefined;
+        jsonSchemaDialect?: string | undefined;
+        info?: {
+            title: string;
+            version: string;
+            description?: string | undefined;
+            summary?: string | undefined;
+            termsOfService?: string | undefined;
+            contact?: {
+                name?: string | undefined;
+                url?: string | undefined;
+                email?: string | undefined;
+            } | undefined;
+            license?: {
+                name: string;
+                identifier?: string | undefined;
+                url?: string | undefined;
+            } | undefined;
+        } | undefined;
+        components?: Record<string, unknown> | undefined;
+        webhooks?: Record<string, unknown> | undefined;
+        'x-scalar-environment'?: string | undefined;
+        'x-scalar-environments'?: Record<string, {
+            variables: Record<string, string | {
+                default: string;
+                description?: string | undefined;
+            }>;
+            description?: string | undefined;
+            color?: string | undefined;
+        }> | undefined;
+        'x-scalar-secrets'?: Record<string, {
+            description?: string | undefined;
+            example?: string | undefined;
+        }> | undefined;
+        documentUrl?: string | undefined;
+        integration?: string | null | undefined;
+    }[]>;
+    activeWorkspaceServers: import("vue").ComputedRef<{
+        uid: string;
+        url: string;
+        description?: string | undefined;
+        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+            enum?: [string, ...string[]];
+        }> | undefined;
+    }[]>;
+    activeEnvVariables: import("vue").ComputedRef<{
+        key: string;
+        value: string;
+    }[]>;
+    activeWorkspaceRequests: import("vue").ComputedRef<string[]>;
+    router: Router;
+};
+export type ActiveEntitiesStore = ReturnType<typeof createActiveEntitiesStore>;
+export declare const ACTIVE_ENTITIES_SYMBOL: InjectionKey<ActiveEntitiesStore>;
+/**
+ * The active entities store
+ *
+ * This store returns anything related to the currently active entities
+ * The only reason this is a store and not a simple hook is due to storing the current router here
+ */
+export declare const useActiveEntities: () => ActiveEntitiesStore;
+export {};
+//# sourceMappingURL=active-entities.d.ts.map

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

@@ -0,0 +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;AACrE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC,KAAK,+BAA+B,GAAG;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,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;CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,2FAQnC,+BAA+B;;;;;;;;;;;;;;;;;;uBAuJs/Z,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAA2W,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;oBAA+/S,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAxF1rlB,CAAC;;;;;;;;;;;;;;mBAwF68E,CAAC;;yBAAq4B,CAAC;;;;;;;;;;;;;;;;;;;;;;uBAA8pT,CAAC;;;;;;uBAAqK,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;;0BAAoD,CAAC;mBAAqC,CAAC;;;;;;;;;2BAA2W,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;gBAxFlmc,CAAC;;;;;;;;;CAuErC,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

@@ -0,0 +1,97 @@
+import { flattenEnvVars as A } from "../libs/string-template.js";
+import { inject as O, computed as r } from "vue";
+import { getRouterParams as U } from "./router-params.js";
+import { PathId as i } from "../routes.js";
+const h = ({
+  collections: a,
+  environments: q,
+  requestExamples: I,
+  requests: f,
+  router: d,
+  servers: E,
+  workspaces: l
+}) => {
+  const s = r(U(d)), n = r(() => l[s.value[i.Workspace]] ?? l[Object.keys(l)[0]]), p = r(
+    () => {
+      var e;
+      return (e = n.value) == null ? void 0 : e.collections.map((t) => a[t]).sort((t, o) => {
+        var c, v;
+        return ((c = t.info) == null ? void 0 : c.title) === "Drafts" ? 1 : ((v = o.info) == null ? void 0 : v.title) === "Drafts" ? -1 : 0;
+      });
+    }
+  ), b = r(
+    () => {
+      var e;
+      return (e = p.value) == null ? void 0 : e.flatMap(
+        (t) => t.servers.map((o) => E[o])
+      );
+    }
+  ), x = r(
+    () => {
+      var e;
+      return (e = p.value) == null ? void 0 : e.flatMap(
+        (t) => t.requests
+      );
+    }
+  ), m = r(
+    () => {
+      var e;
+      return q[((e = n.value) == null ? void 0 : e.activeEnvironmentId) ?? "default"];
+    }
+  ), u = r(() => {
+    const e = s.value[i.Request], t = a[s.value.collection] || a[n.value.collections[0]];
+    return f[e] || f[t == null ? void 0 : t.requests[0]];
+  }), C = r(() => {
+    var t;
+    const e = s.value[i.Examples] === "default" ? ((t = u.value) == null ? void 0 : t.examples[0]) || "" : s.value[i.Examples];
+    return I[e];
+  }), k = r(() => {
+    var o, c;
+    const e = (o = u.value) == null ? void 0 : o.uid;
+    if (e)
+      return Object.values(a).find(
+        (v) => {
+          var S;
+          return (S = v.requests) == null ? void 0 : S.includes(e);
+        }
+      );
+    const t = n.value.collections[0] ?? ((c = a[0]) == null ? void 0 : c.uid);
+    return a[t];
+  }), R = r(
+    () => {
+      var e, t;
+      return E[((e = u.value) == null ? void 0 : e.selectedServerUid) || ((t = k.value) == null ? void 0 : t.selectedServerUid) || ""];
+    }
+  ), W = r(
+    () => s.value[i.Cookies]
+  ), y = r(() => m.value ? A(JSON.parse(m.value.value)).map(
+    ([e, t]) => ({
+      key: e,
+      value: t
+    })
+  ) : []);
+  return {
+    activeCollection: k,
+    activeCookieId: W,
+    activeExample: C,
+    activeRequest: u,
+    activeRouterParams: s,
+    activeEnvironment: m,
+    activeServer: R,
+    activeWorkspace: n,
+    activeWorkspaceCollections: p,
+    activeWorkspaceServers: b,
+    activeEnvVariables: y,
+    activeWorkspaceRequests: x,
+    router: d
+  };
+}, j = Symbol(), w = () => {
+  const a = O(j);
+  if (!a) throw new Error("Active entities store not provided");
+  return a;
+};
+export {
+  j as ACTIVE_ENTITIES_SYMBOL,
+  h as createActiveEntitiesStore,
+  w as useActiveEntities
+};