@scalar/api-reference 1.25.127 → 1.25.128

package/dist/types.d.ts

@@ -1,13 +1,30 @@
 import type { HarRequest } from '@scalar/snippetz/types';
 import type { ThemeId } from '@scalar/themes';
+import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
 import type { ContentType, ReferenceConfiguration, Spec } from '@scalar/types/legacy';
 import type { Slot } from 'vue';
+export type { ApiReferenceConfiguration };
 export type { ReferenceConfiguration };
+/**
+ * Props for the ApiReference components, coming from user input
+ */
 export type ReferenceProps = {
-    configuration?: ReferenceConfiguration;
+    configuration?: Partial<ApiReferenceConfiguration> | ReferenceConfiguration;
 };
+/**
+ * Before the configuration is parsed, we can use the broader types.
+ */
 export type ReferenceLayoutProps = {
-    configuration: ReferenceConfiguration;
+    configuration: Partial<ApiReferenceConfiguration> | ReferenceConfiguration;
+    parsedSpec: Spec;
+    rawSpec: string;
+    isDark: boolean;
+};
+/**
+ * After the configuration is parsed, we can use the stricter types.
+ */
+export type InternalReferenceProps = {
+    configuration: ApiReferenceConfiguration;
     parsedSpec: Spec;
     rawSpec: string;
     isDark: boolean;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACrF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,CAAA;AAE/B,YAAY,EAAE,sBAAsB,EAAE,CAAA;AAEtC,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,sBAAsB,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEtD,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG;KAE1B,CAAC,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClD,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,mBAAmB,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,GAAG;CAC/D,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IACxC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;CAC5B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACrF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,CAAA;AAE/B,YAAY,EAAE,yBAAyB,EAAE,CAAA;AAEzC,YAAY,EAAE,sBAAsB,EAAE,CAAA;AAEtC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,sBAAsB,CAAA;CAC5E,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,sBAAsB,CAAA;IAC1E,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,yBAAyB,CAAA;IACxC,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEtD,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG;KAE1B,CAAC,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClD,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,mBAAmB,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,GAAG;CAC/D,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IACxC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;CAC5B,CAAA"}

package/package.json

@@ -20,7 +20,7 @@
     "vue",
     "vue3"
   ],
-  "version": "1.25.127",
+  "version": "1.25.128",
   "engines": {
     "node": ">=18"
   },
@@ -55,16 +55,17 @@
     "github-slugger": "^2.0.0",
     "nanoid": "^5.0.9",
     "vue": "^3.5.12",
-    "@scalar/api-client": "2.2.56",
+    "zod": "^3.23.8",
     "@scalar/code-highlight": "0.0.23",
-    "@scalar/components": "0.13.28",
-    "@scalar/openapi-parser": "0.10.9",
+    "@scalar/api-client": "2.2.57",
+    "@scalar/components": "0.13.29",
     "@scalar/openapi-types": "0.1.9",
-    "@scalar/oas-utils": "0.2.110",
+    "@scalar/openapi-parser": "0.10.9",
     "@scalar/snippetz": "0.2.15",
-    "@scalar/types": "0.0.36",
-    "@scalar/themes": "0.9.71",
-    "@scalar/use-hooks": "0.1.25",
+    "@scalar/oas-utils": "0.2.111",
+    "@scalar/themes": "0.9.72",
+    "@scalar/use-hooks": "0.1.26",
+    "@scalar/types": "0.0.37",
     "@scalar/use-toasts": "0.7.9"
   },
   "devDependencies": {
@@ -79,8 +80,8 @@
     "vite-plugin-banner": "^0.7.1",
     "vite-plugin-css-injected-by-js": "^3.4.0",
     "vitest": "^1.6.0",
-    "@scalar/build-tooling": "0.1.15",
-    "@scalar/galaxy": "0.2.22"
+    "@scalar/galaxy": "0.2.23",
+    "@scalar/build-tooling": "0.1.16"
   },
   "scripts": {
     "analyze:default": "pnpm dlx vite-bundle-visualizer",

package/dist/hooks/useDeprecationWarnings.d.ts

@@ -1,6 +0,0 @@
-import type { ReferenceConfiguration } from '@scalar/types/legacy';
-/**
- * Warns the user about deprecated configurations in the browser console.
- */
-export declare function useDeprecationWarnings(configuration: ReferenceConfiguration): void;
-//# sourceMappingURL=useDeprecationWarnings.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useDeprecationWarnings.d.ts","sourceRoot":"","sources":["../../src/hooks/useDeprecationWarnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAOlE;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,sBAAsB,QA4B3E"}

package/dist/hooks/useDeprecationWarnings.js

@@ -1,20 +0,0 @@
-import { watch as t } from "vue";
-const o = "https://api.scalar.com/request-proxy", r = "https://proxy.scalar.com";
-function p(e) {
-  t(
-    () => e,
-    () => {
-      e.proxy && console.warn(
-        "[DEPRECATED] You’re using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package."
-      ), (e.proxyUrl || e.proxy) === o && (console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${o}).`), console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${r}) instead.`), delete e.proxy, e.proxyUrl = r, console.warn(
-        `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${r}). Read more: https://github.com/scalar/scalar`
-      ));
-    },
-    {
-      immediate: !0
-    }
-  );
-}
-export {
-  p as useDeprecationWarnings
-};