@scalar/api-client 2.5.27 → 2.5.28

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/api-client
 
+## 2.5.28
+
+### Patch Changes
+
+- c470c60: fix(components): update scalar menu button flex
+- abe3842: Add analytic events to api-client + add telemetry option
+- 5a7d388: fix(api-client): don't apply block layout on desktop
+- Updated dependencies [c470c60]
+- Updated dependencies [abe3842]
+  - @scalar/components@0.14.29
+  - @scalar/types@0.2.15
+  - @scalar/use-codemirror@0.12.30
+  - @scalar/oas-utils@0.4.24
+  - @scalar/openapi-parser@0.20.2
+  - @scalar/snippetz@0.4.9
+  - @scalar/themes@0.13.16
+  - @scalar/workspace-store@0.15.1
+  - @scalar/postman-to-openapi@0.3.27
+
 ## 2.5.27
 
 ### Patch Changes

package/dist/analytics.d.ts

@@ -0,0 +1,69 @@
+/** Centralized method to control creation of analytics clients.  */
+export declare function createAnalyticsClient(): {
+    capture: <E extends "client-send-request" | "page-view">(event: E, ...[data]: import("zod").input<{
+        readonly 'page-view': import("zod").ZodObject<{
+            to: import("zod").ZodString;
+            from: import("zod").ZodString;
+            hostname: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            to: string;
+            from: string;
+            hostname: string;
+        }, {
+            to: string;
+            from: string;
+            hostname: string;
+        }>;
+        readonly 'client-send-request': import("zod").ZodUndefined;
+    }[E]> extends undefined ? [] : [import("zod").input<{
+        readonly 'page-view': import("zod").ZodObject<{
+            to: import("zod").ZodString;
+            from: import("zod").ZodString;
+            hostname: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            to: string;
+            from: string;
+            hostname: string;
+        }, {
+            to: string;
+            from: string;
+            hostname: string;
+        }>;
+        readonly 'client-send-request': import("zod").ZodUndefined;
+    }[E]>]) => Promise<void>;
+};
+/** Gets the correct analytics client based on the layout. */
+export declare function useAnalytics(): {
+    capture: <E extends "client-send-request" | "page-view">(event: E, ...[data]: import("zod").input<{
+        readonly 'page-view': import("zod").ZodObject<{
+            to: import("zod").ZodString;
+            from: import("zod").ZodString;
+            hostname: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            to: string;
+            from: string;
+            hostname: string;
+        }, {
+            to: string;
+            from: string;
+            hostname: string;
+        }>;
+        readonly 'client-send-request': import("zod").ZodUndefined;
+    }[E]> extends undefined ? [] : [import("zod").input<{
+        readonly 'page-view': import("zod").ZodObject<{
+            to: import("zod").ZodString;
+            from: import("zod").ZodString;
+            hostname: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            to: string;
+            from: string;
+            hostname: string;
+        }, {
+            to: string;
+            from: string;
+            hostname: string;
+        }>;
+        readonly 'client-send-request': import("zod").ZodUndefined;
+    }[E]>]) => Promise<void>;
+} | undefined;
+//# sourceMappingURL=analytics.d.ts.map

package/dist/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAOA,oEAAoE;AACpE,wBAAgB,qBAAqB;uEAQpC,GAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAHJ;AAED,6DAA6D;AAC7D,wBAAgB,YAAY;uEAA3B,GAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAiBJ"}

package/dist/analytics.js

@@ -0,0 +1,25 @@
+import { analyticsFactory as n } from "@scalar/analytics-client";
+import { useClientConfig as o } from "./hooks/useClientConfig.js";
+import { analytics as i } from "./layouts/Web/create-api-client-web.js";
+import { analytics as a } from "./layouts/App/create-api-client-app.js";
+import { useLayout as r } from "./hooks/useLayout.js";
+function y() {
+  return n(
+    "https://api.scalar.com",
+    () => null
+    // There is no auth to return.
+  );
+}
+function f() {
+  const { layout: t } = r();
+  return o().value.telemetry ? {
+    desktop: a,
+    web: i,
+    modal: void 0
+    // There are currently no analytics for the modal layout.
+  }[t] : void 0;
+}
+export {
+  y as createAnalyticsClient,
+  f as useAnalytics
+};

package/dist/components/DataTable/DataTableInput.vue.d.ts

@@ -40,8 +40,8 @@ declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {}, {}
     onInputFocus?: (() => any) | undefined;
     onInputBlur?: (() => any) | undefined;
 }>, {
-    required: boolean;
     readOnly: boolean;
+    required: boolean;
     lineWrapping: boolean;
     canAddCustomEnumValue: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/components/DataTable/DataTableInput.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataTableInput.vue.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/DataTableInput.vue"],"names":[],"mappings":"AAsMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAIrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAK/C,KAAK,WAAW,GAAG;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,sEAAsE;IACtE,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B,0EAA0E;IAC1E,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,WAAW,CAAA;IACxB,YAAY,EAAE,WAAW,EAAE,CAAA;IAC3B,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAC;AA0SJ,QAAA,IAAI,OAAO,IAAU,EAAuB,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AACvF,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAiC7C,QAAA,MAAM,eAAe;;;;;;;;;;;cA5VN,OAAO;cAIP,OAAO;kBAQH,OAAO;2BATE,OAAO;6EAiWjC,CAAC;wBACkB,eAAe,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;AAAzE,wBAA0E;AAa1E,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}
+{"version":3,"file":"DataTableInput.vue.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/DataTableInput.vue"],"names":[],"mappings":"AAsMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAIrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAK/C,KAAK,WAAW,GAAG;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,sEAAsE;IACtE,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3B,0EAA0E;IAC1E,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,WAAW,CAAA;IACxB,YAAY,EAAE,WAAW,EAAE,CAAA;IAC3B,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAC;AA0SJ,QAAA,IAAI,OAAO,IAAU,EAAuB,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AACvF,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAiC7C,QAAA,MAAM,eAAe;;;;;;;;;;;cAxVN,OAAO;cAJP,OAAO;kBAYH,OAAO;2BATE,OAAO;6EAiWjC,CAAC;wBACkB,eAAe,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;AAAzE,wBAA0E;AAa1E,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/components/HttpMethod/HttpMethod.vue.d.ts

@@ -4,9 +4,9 @@ type __VLS_Props = {
     isEditable?: boolean;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
-    change: (value: "delete" | "get" | "options" | "connect" | "head" | "patch" | "post" | "put" | "trace") => any;
+    change: (value: "head" | "delete" | "get" | "options" | "connect" | "patch" | "post" | "put" | "trace") => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onChange?: ((value: "delete" | "get" | "options" | "connect" | "head" | "patch" | "post" | "put" | "trace") => any) | undefined;
+    onChange?: ((value: "head" | "delete" | "get" | "options" | "connect" | "patch" | "post" | "put" | "trace") => any) | undefined;
 }>, {
     isEditable: boolean;
     isSquare: boolean;

package/dist/components/Sidebar/SidebarButton.vue.js

@@ -1,4 +1,4 @@
-import { defineComponent as u, createBlock as e, openBlock as r, unref as o, withCtx as i, renderSlot as p, createCommentVNode as s } from "vue";
+import { defineComponent as u, createBlock as o, openBlock as r, unref as e, withCtx as i, renderSlot as p, createCommentVNode as s } from "vue";
 import { ScalarButton as d, ScalarHotkey as k } from "@scalar/components";
 import { useLayout as m } from "../../hooks/useLayout.js";
 const g = /* @__PURE__ */ u({
@@ -11,7 +11,7 @@ const g = /* @__PURE__ */ u({
     const l = a, { layout: n } = m(), c = () => {
       l.click();
     };
-    return (t, h) => (r(), e(o(d), {
+    return (t, h) => (r(), o(e(d), {
       class: "bg-b-1 text-c-1 hover:bg-b-2 group relative h-auto w-auto border px-2 py-1 md:w-full md:p-1.5",
       icon: "Plus",
       variant: "outlined",
@@ -19,9 +19,9 @@ const g = /* @__PURE__ */ u({
     }, {
       default: i(() => [
         p(t.$slots, "title"),
-        t.hotkey && o(n) === "desktop" ? (r(), e(o(k), {
+        t.hotkey && e(n) === "desktop" ? (r(), o(e(k), {
           key: 0,
-          class: "text-c-2 add-item-hotkey absolute right-2 hidden group-hover:opacity-80 md:block",
+          class: "text-c-2 add-item-hotkey absolute right-2 hidden group-hover:opacity-80 md:flex",
           hotkey: t.hotkey
         }, null, 8, ["hotkey"])) : s("", !0)
       ]),

package/dist/hooks/useClientConfig.d.ts

@@ -8,6 +8,7 @@ export declare const useClientConfig: () => Ref<{
     operationTitleSource: "path" | "summary";
     theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
     persistAuth: boolean;
+    telemetry: boolean;
     title?: string | undefined | undefined;
     url?: string | undefined | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
@@ -55,6 +56,7 @@ export declare const useClientConfig: () => Ref<{
     operationTitleSource: "path" | "summary";
     theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
     persistAuth: boolean;
+    telemetry: boolean;
     title?: string | undefined;
     url?: string | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
@@ -102,6 +104,7 @@ export declare const useClientConfig: () => Ref<{
     operationTitleSource: "path" | "summary";
     theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
     persistAuth: boolean;
+    telemetry: boolean;
     title?: string | undefined | undefined;
     url?: string | undefined | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;

package/dist/hooks/useClientConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useClientConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useClientConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,KAAK,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACvG,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,eAAO,MAAM,2BAA2B,EAAe,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAEhG,0DAA0D;AAC1D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;sCACwgd,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;;;;;;;;;+CAA/yD,GAAG;;;aAAsH,CAAC;WAAiC,CAAC;eAAqC,CAAC,mCAAmC,GAAG;YAAyE,CAAC;;;;;;;;sCAA6pB,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;;;;;;;;;;;;;;;;;;;;;;;sCAAh2B,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;EAD/we,CAAA"}
+{"version":3,"file":"useClientConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useClientConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAgC,MAAM,6BAA6B,CAAA;AACvG,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,eAAO,MAAM,2BAA2B,EAAe,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAEhG,0DAA0D;AAC1D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;sCACiod,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;;;;;;;;;;+CAA/yD,GAAG;;;aAAsH,CAAC;WAAiC,CAAC;eAAqC,CAAC,mCAAmC,GAAG;YAAyE,CAAC;;;;;;;;sCAA6pB,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;;;;;;;;;;;;;;;;;;;;;;;;sCAAh2B,GAAI;gBAAuD,GAAG;;aAAyD,CAAC;6BAAiC,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;8BAA8F,CAAC;qBAAyB,CAAC;yBAA+C,CAAC;qBAAgC,CAAC;;;aAAoG,CAAC;2BAA+B,CAAC;;eAA8D,GAAI;8BAAqF,CAAC;;;eAAgH,GAAI;;;EADx4e,CAAA"}

package/dist/index.js

@@ -1,19 +1,20 @@
 import "./style.css.js";
-import { useWorkspace as p } from "./store/store.js";
+import { useWorkspace as a } from "./store/store.js";
 import { createModalRouter as i, createWebHashRouter as l, createWebHistoryRouter as c } from "./router.js";
 import { default as m } from "./layouts/App/ApiClientApp.vue.js";
 import "./layouts/App/ApiClientApp.vue2.js";
-import { default as d } from "./layouts/Modal/ApiClientModal.vue.js";
-import { createApiClientModal as s, createApiClientModalSync as u } from "./layouts/Modal/create-api-client-modal.js";
-import { createApiClientApp as C } from "./layouts/App/create-api-client-app.js";
+import { default as s } from "./layouts/Modal/ApiClientModal.vue.js";
+import { createApiClientModal as d, createApiClientModalSync as u } from "./layouts/Modal/create-api-client-modal.js";
+import { analytics as C, createApiClientApp as M } from "./layouts/App/create-api-client-app.js";
 export {
   m as ApiClientApp,
-  d as ApiClientModal,
-  C as createApiClientApp,
-  s as createApiClientModal,
+  s as ApiClientModal,
+  C as analytics,
+  M as createApiClientApp,
+  d as createApiClientModal,
   u as createApiClientModalSync,
   i as createModalRouter,
   l as createWebHashRouter,
   c as createWebHistoryRouter,
-  p as useWorkspace
+  a as useWorkspace
 };