@scalar/oas-utils 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scalar/oas-utils
 
+## 0.1.13
+
+### Patch Changes
+
+- 5aa656f: feat: [BREAKING CHANGE] use new HTTP proxy (https://github.com/scalar/scalar/pull/1703)
+
+## 0.1.12
+
+### Patch Changes
+
+- 61b8ddc: fix: doesn’t render preview for mimetype variations like application/foobar+json
+- 165b901: feat: dynamic values for generated examples
+
 ## 0.1.11
 
 ### Patch Changes

package/dist/fetchSpecFromUrl.d.ts

@@ -0,0 +1,3 @@
+/** Fetches an OpenAPI/Swagger specification from a given URL. */
+export declare function fetchSpecFromUrl(url: string, proxy?: string): Promise<string>;
+//# sourceMappingURL=fetchSpecFromUrl.d.ts.map

package/dist/fetchSpecFromUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchSpecFromUrl.d.ts","sourceRoot":"","sources":["../src/fetchSpecFromUrl.ts"],"names":[],"mappings":"AAOA,iEAAiE;AACjE,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CAmBjB"}

package/dist/getExampleFromSchema.d.ts

@@ -17,5 +17,9 @@ export declare const getExampleFromSchema: (schema: Record<string, any>, options
      * @default undefined
      */
     mode?: 'read' | 'write';
+    /**
+     * Dynamic values to add to the example.
+     */
+    variables?: Record<string, any>;
 }, level?: number) => any;
 //# sourceMappingURL=getExampleFromSchema.d.ts.map

package/dist/getExampleFromSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../src/getExampleFromSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB,UACM,MAAM,KACZ,GA+NF,CAAA"}
+{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../src/getExampleFromSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC,UACM,MAAM,KACZ,GA8OF,CAAA"}

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 export { createHash } from './createHash';
-export { fetchSpecFromUrl } from './fetch-spec';
+export { defaultStateFactory, ssrState } from './ssrState';
+export { fetchSpecFromUrl } from './fetchSpecFromUrl';
 export { getExampleFromSchema } from './getExampleFromSchema';
 export { getHarRequest } from './getHarRequest';
 export { getParametersFromOperation } from './getParametersFromOperation';
 export { getRequestBodyFromOperation } from './getRequestBodyFromOperation';
 export { getRequestFromOperation } from './getRequestFromOperation';
-export type { HttpStatusCode, HttpStatusCodes } from './httpStatusCodes';
 export { httpStatusCodes } from './httpStatusCodes';
-export { normalizeMimeTypeObject } from './normalizeMimeTypeObject';
 export { json2xml } from './json2xml';
-export { formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml, } from './parse';
+export { normalizeMimeTypeObject } from './normalizeMimeTypeObject';
 export { prettyPrintJson } from './prettyPrintJson';
-export { defaultStateFactory, ssrState } from './ssrState';
+export * from './normalizeMimeType';
 export * from './types';
+export type { HttpStatusCode, HttpStatusCodes } from './httpStatusCodes';
+export { formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml, } from './parse';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAC3E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EACL,sBAAsB,EACtB,YAAY,EACZ,IAAI,EACJ,eAAe,EACf,eAAe,EACf,IAAI,GACL,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1D,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAC3E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,cAAc,qBAAqB,CAAA;AACnC,cAAc,SAAS,CAAA;AACvB,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxE,OAAO,EACL,sBAAsB,EACtB,YAAY,EACZ,IAAI,EACJ,eAAe,EACf,eAAe,EACf,IAAI,GACL,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -15,6 +15,9 @@ const createHash = (input) => {
   return hash;
 };
 
+const defaultStateFactory = () => ({});
+const ssrState = typeof window !== "undefined" ? window.__SCALAR__ ?? defaultStateFactory() : defaultStateFactory();
+
 const yaml = {
   /** Parse and throw if the return value is not an object */
   parse: (val) => {
@@ -83,25 +86,22 @@ const parseJsonOrYaml = (value) => {
   });
 };
 
+function redirectToProxy(proxy, url) {
+  return `${proxy}?scalar_url=${encodeURI(url)}`;
+}
 async function fetchSpecFromUrl(url, proxy) {
-  const response = proxy ? await fetch(proxy, {
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json"
-    },
-    body: JSON.stringify({
-      method: "GET",
-      url
-    })
-  }) : await fetch(url);
+  const response = await fetch(proxy ? redirectToProxy(proxy, url) : url);
   if (response.status !== 200) {
-    const proxyWarning = proxy ? "" : "Trying to fetch the spec file without a proxy. The CORS headers must be set properly or the request will fail.";
     console.error(
-      `[fetchSpecFromUrl] Failed to fetch the spec at ${url}. ${proxyWarning}`
+      `[fetchSpecFromUrl] Failed to fetch the specification at ${url} (Status: ${response.status})`
     );
+    if (!proxy) {
+      console.warn(
+        `[fetchSpecFromUrl] Tried to fetch the specification (url: ${url}) without a proxy. Are the CORS headers configured to allow cross-domain requests? https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS`
+      );
+    }
   }
-  const payload = proxy ? String((await response.json()).data) : await response.text();
-  return formatJsonOrYamlString(payload);
+  return formatJsonOrYamlString(await response.text());
 }
 
 const getExampleFromSchema = (schema, options, level = 0) => {
@@ -114,6 +114,15 @@ const getExampleFromSchema = (schema, options, level = 0) => {
   if (options?.mode === "read" && schema.writeOnly) {
     return void 0;
   }
+  if (schema["x-variable"]) {
+    const value = options?.variables?.[schema["x-variable"]];
+    if (value !== void 0) {
+      if (schema.type === "number" || schema.type === "integer") {
+        return parseInt(value, 10);
+      }
+      return value;
+    }
+  }
   if (Array.isArray(schema.examples) && schema.examples.length > 0) {
     return schema.examples[0];
   }
@@ -364,6 +373,10 @@ function json2xml(data, tab) {
   return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
 }
 
+function normalizeMimeType(contentType) {
+  return contentType.replace(/;.*$/, "").replace(/\/.+\+/, "/").trim();
+}
+
 function normalizeMimeTypeObject(content) {
   if (!content) {
     return content;
@@ -372,7 +385,7 @@ function normalizeMimeTypeObject(content) {
     ...content
   };
   Object.keys(newContent).forEach((key) => {
-    const newKey = key.replace(/;.*$/, "").replace(/\/.+\+/, "/").trim();
+    const newKey = normalizeMimeType(key);
     newContent[newKey] = newContent[key];
     if (key !== newKey) {
       delete newContent[key];
@@ -823,7 +836,4 @@ const httpStatusCodes = {
   }
 };
 
-const defaultStateFactory = () => ({});
-const ssrState = typeof window !== "undefined" ? window.__SCALAR__ ?? defaultStateFactory() : defaultStateFactory();
-
-export { createHash, defaultStateFactory, fetchSpecFromUrl, formatJsonOrYamlString, getExampleFromSchema, getHarRequest, getParametersFromOperation, getRequestBodyFromOperation, getRequestFromOperation, httpStatusCodes, isJsonString, json, json2xml, normalizeMimeTypeObject, parseJsonOrYaml, prettyPrintJson, ssrState, transformToJson, yaml };
+export { createHash, defaultStateFactory, fetchSpecFromUrl, formatJsonOrYamlString, getExampleFromSchema, getHarRequest, getParametersFromOperation, getRequestBodyFromOperation, getRequestFromOperation, httpStatusCodes, isJsonString, json, json2xml, normalizeMimeType, normalizeMimeTypeObject, parseJsonOrYaml, prettyPrintJson, ssrState, transformToJson, yaml };

package/dist/normalizeMimeType.d.ts

@@ -0,0 +1,3 @@
+import type { ContentType } from './types';
+export declare function normalizeMimeType(contentType: string): ContentType;
+//# sourceMappingURL=normalizeMimeType.d.ts.map

package/dist/normalizeMimeType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeMimeType.d.ts","sourceRoot":"","sources":["../src/normalizeMimeType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,eAUpD"}

package/dist/normalizeMimeTypeObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeMimeTypeObject.d.ts","sourceRoot":"","sources":["../src/normalizeMimeTypeObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC;;;;;;;;cA6BzE"}
+{"version":3,"file":"normalizeMimeTypeObject.d.ts","sourceRoot":"","sources":["../src/normalizeMimeTypeObject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC;;;;;;;;cAuBzE"}

package/dist/parse.d.ts

@@ -25,7 +25,7 @@ export declare const isJsonString: (value?: any) => boolean;
  * This helper is used to transform the content of the swagger file to JSON, even it was YAML.
  */
 export declare const transformToJson: (value: string) => string;
-/** Validates a JSON string if provided. Otherwise returns the raw Yaml */
+/** Validates a JSON string if provided. Otherwise returns the raw YAML */
 export declare function formatJsonOrYamlString(value: string): string;
 /** Parse JSON or YAML into an object */
 export declare const parseJsonOrYaml: (value: string | AnyObject) => AnyObject;

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.1.11",
+  "version": "0.1.13",
   "engines": {
     "node": ">=18"
   },

package/dist/fetch-spec.d.ts

@@ -1,3 +0,0 @@
-/** Fetches an OAS spec file from a given URL. */
-export declare function fetchSpecFromUrl(url: string, proxy?: string): Promise<string>;
-//# sourceMappingURL=fetch-spec.d.ts.map

package/dist/fetch-spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetch-spec.d.ts","sourceRoot":"","sources":["../src/fetch-spec.ts"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CA8BjB"}