@scalar/api-reference 1.25.127 → 1.25.128

package/dist/standalone/lib/html-api.d.ts

@@ -1,11 +1,11 @@
-import type { ReferenceConfiguration } from '@scalar/types/legacy';
+import { type ApiReferenceConfiguration } from '@scalar/types/api-reference';
 /**
  * Reading the configuration from the data-attributes.
  */
-export declare function getConfigurationFromDataAttributes(doc: Document): ReferenceConfiguration;
+export declare function getConfigurationFromDataAttributes(doc: Document): ApiReferenceConfiguration;
 /**
  * Mount the Scalar API Reference on a given document.
  * Read the HTML data-attributes for configuration.
  */
-export declare function mountScalarApiReference(doc: Document, configuration: ReferenceConfiguration): void;
+export declare function mountScalarApiReference(doc: Document, configuration: ApiReferenceConfiguration): void;
 //# sourceMappingURL=html-api.d.ts.map

package/dist/standalone/lib/html-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAQlE;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,sBAAsB,CA8GxF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,sBAAsB,QAsF3F"}
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,KAAK,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAQ7G;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA8G3F;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAsF9F"}

package/dist/standalone/lib/html-rendering.d.ts

@@ -1,8 +1,9 @@
-import type { ReferenceConfiguration } from '../../types';
+import { type ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import { z } from 'zod';
 /**
- * The CDN configuration for the Scalar API Reference.
+ * Zod schema for HTML rendering configuration
  */
-export type CdnConfiguration = {
+export declare const htmlRenderingOptionsSchema: z.ZodObject<{
     /**
      * The URL to the Scalar API Reference JS CDN.
      *
@@ -12,40 +13,38 @@ export type CdnConfiguration = {
      *
      * @example https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.122
      */
-    cdn?: string;
-};
-/**
- * The page title configuration for the Scalar API Reference.
- */
-export type PageTitleConfiguration = {
+    cdn: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     /**
      * The title of the page.
      */
-    pageTitle?: string;
-};
-export type HtmlRenderingConfiguration = ReferenceConfiguration & CdnConfiguration & PageTitleConfiguration;
+    pageTitle: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    cdn: string;
+    pageTitle: string;
+}, {
+    cdn?: string | undefined;
+    pageTitle?: string | undefined;
+}>;
+type HtmlRenderingOptions = z.infer<typeof htmlRenderingOptionsSchema>;
+export type HtmlRenderingConfiguration = ApiReferenceConfiguration & HtmlRenderingOptions;
 /**
  * The HTML document to render the Scalar API reference.
+ *
+ * We must check the passed in configuration and not the parsedConfig for the theme as the parsedConfig will have it
+ * defaulted to 'default'
  */
-export declare function getHtmlDocument(configuration: HtmlRenderingConfiguration, customTheme?: string): string;
+export declare const getHtmlDocument: (configuration: Partial<HtmlRenderingConfiguration>, customTheme?: string) => string;
 /**
  * The script tags to load the @scalar/api-reference package from the CDN.
  */
-export declare function getScriptTags(configuration: HtmlRenderingConfiguration): string;
+export declare function getScriptTags(configuration: ApiReferenceConfiguration, cdn: string): string;
 /**
  * The configuration to pass to the @scalar/api-reference package.
  */
-export declare function getConfiguration(givenConfiguration: HtmlRenderingConfiguration): string;
+export declare const getConfiguration: (givenConfiguration: ApiReferenceConfiguration) => string;
 /**
  * The content to pass to the @scalar/api-reference package as the <script> tag content.
  */
-export declare function getScriptTagContent(configuration: HtmlRenderingConfiguration): string;
-/**
- * The CDN URL to load the @scalar/api-reference package from.
- */
-export declare function getCdnUrl(configuration: HtmlRenderingConfiguration): string;
-/**
- * The page title for the Scalar API Reference.
- */
-export declare function getPageTitle(configuration: HtmlRenderingConfiguration): string;
+export declare const getScriptTagContent: (configuration: ApiReferenceConfiguration) => string;
+export {};
 //# sourceMappingURL=html-rendering.d.ts.map

package/dist/standalone/lib/html-rendering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAErD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG,gBAAgB,GAAG,sBAAsB,CAAA;AAE3G;;GAEG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,0BAA0B,EAAE,WAAW,CAAC,EAAE,MAAM,UAmB9F;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,0BAA0B,UAQtE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,kBAAkB,EAAE,0BAA0B,UAa9E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,0BAA0B,UAM5E;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,aAAa,EAAE,0BAA0B,UAElE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,0BAA0B,UAErE"}
+{"version":3,"file":"html-rendering.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-rendering.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,KAAK,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC7G,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,0BAA0B;IACrC;;;;;;;;OAQG;;IAEH;;OAEG;;;;;;;;EAEH,CAAA;AACF,KAAK,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEtE,MAAM,MAAM,0BAA0B,GAAG,yBAAyB,GAAG,oBAAoB,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,kBAAmB,OAAO,CAAC,0BAA0B,CAAC,iCAuBjF,CAAA;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,yBAAyB,EAAE,GAAG,EAAE,MAAM,UAQlF;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,uBAAwB,yBAAyB,WAa7E,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAmB,yBAAyB,WAKpE,CAAA"}

package/dist/standalone/lib/html-rendering.js

@@ -1,54 +1,64 @@
-function o(t, e) {
+import { apiReferenceConfigurationSchema as o } from "@scalar/types/api-reference";
+import { z as s } from "zod";
+const a = s.object({
+  /**
+   * The URL to the Scalar API Reference JS CDN.
+   *
+   * Use this to pin a specific version of the Scalar API Reference.
+   *
+   * @default https://cdn.jsdelivr.net/npm/@scalar/api-reference
+   *
+   * @example https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.122
+   */
+  cdn: s.string().optional().default("https://cdn.jsdelivr.net/npm/@scalar/api-reference"),
+  /**
+   * The title of the page.
+   */
+  pageTitle: s.string().optional().default("Scalar API Reference")
+}), h = (e, t = "") => {
+  const { cdn: n, pageTitle: c, ...i } = e, r = a.parse({ cdn: n, pageTitle: c, customTheme: t }), p = o.parse(i);
   return `
     <!DOCTYPE html>
     <html>
       <head>
-        <title>${a(t)}</title>
+        <title>${r.pageTitle}</title>
         <meta charset="utf-8" />
         <meta
           name="viewport"
           content="width=device-width, initial-scale=1" />
         <style>
-          ${t.theme ? null : e ?? ""}
+          ${e.theme ? "" : t}
         </style>
       </head>
       <body>
-        ${r(t)}
+        ${l(p, r.cdn)}
       </body>
     </html>
   `;
-}
-function r(t) {
+};
+function l(e, t) {
   return `
       <script
         id="api-reference"
         type="application/json"
-        data-configuration="${s(t)}">${p(t)}<\/script>
-        <script src="${l(t)}"><\/script>
+        data-configuration="${d(e)}">${f(e)}<\/script>
+        <script src="${t}"><\/script>
     `;
 }
-function s(t) {
+const d = (e) => {
   var n, c, i;
-  const e = {
-    ...t
+  const t = {
+    ...e
   };
-  return (n = e.spec) != null && n.url ? (c = e.spec) != null && c.content && ((i = e.spec) == null || delete i.content) : delete e.spec, JSON.stringify(e).split('"').join("&quot;");
-}
-function p(t) {
-  var e, n, c, i;
-  return (e = t.spec) != null && e.content ? typeof ((n = t.spec) == null ? void 0 : n.content) == "function" ? JSON.stringify((c = t.spec) == null ? void 0 : c.content()) : JSON.stringify((i = t.spec) == null ? void 0 : i.content) : "";
-}
-function l(t) {
-  return t.cdn || "https://cdn.jsdelivr.net/npm/@scalar/api-reference";
-}
-function a(t) {
-  return t.pageTitle || "Scalar API Reference";
-}
+  return (n = t.spec) != null && n.url ? (c = t.spec) != null && c.content && ((i = t.spec) == null || delete i.content) : delete t.spec, JSON.stringify(t).split('"').join("&quot;");
+}, f = (e) => {
+  var t, n, c, i;
+  return (t = e.spec) != null && t.content ? typeof ((n = e.spec) == null ? void 0 : n.content) == "function" ? JSON.stringify((c = e.spec) == null ? void 0 : c.content()) : JSON.stringify((i = e.spec) == null ? void 0 : i.content) : "";
+};
 export {
-  l as getCdnUrl,
-  s as getConfiguration,
-  o as getHtmlDocument,
-  a as getPageTitle,
-  p as getScriptTagContent,
-  r as getScriptTags
+  d as getConfiguration,
+  h as getHtmlDocument,
+  f as getScriptTagContent,
+  l as getScriptTags,
+  a as htmlRenderingOptionsSchema
 };

package/dist/stores/useHttpClientStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useHttpClientStore.d.ts","sourceRoot":"","sources":["../../src/stores/useHttpClientStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,KAAK,GAAG,EAAqC,MAAM,KAAK,CAAA;AASjE;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAE9C;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAM9C;AAYD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAkD5F;AASD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAMxE,iBAAS,oBAAoB,CAAC,UAAU,CAAC,EAAE,eAAe,QAQzD;AAkCD,iBAAS,UAAU,SAElB;AAYD,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;;4BA/DY,QAAQ;4BAAa,MAAM;;;8BAuDrC,OAAO,CAAC,eAAe,CAAC;;qBAcP,GAAG,CAAC,aAAa,CAAC;4BACxC,aAAa;;;;;;CAaxC,CAAA"}
+{"version":3,"file":"useHttpClientStore.d.ts","sourceRoot":"","sources":["../../src/stores/useHttpClientStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,KAAK,GAAG,EAAqC,MAAM,KAAK,CAAA;AASjE;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAE9C;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAM9C;AAYD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAkD5F;AASD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAMxE,iBAAS,oBAAoB,CAAC,UAAU,CAAC,EAAE,eAAe,QAKzD;AAiCD,iBAAS,UAAU,SAElB;AAYD,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;;4BA3DY,QAAQ;4BAAa,MAAM;;;8BAmDrC,OAAO,CAAC,eAAe,CAAC;;qBAcP,GAAG,CAAC,aAAa,CAAC;4BACxC,aAAa;;;;;;CAaxC,CAAA"}