@scalar/oas-utils 0.1.12 → 0.1.14

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scalar/oas-utils
 
+## 0.1.14
+
+### Patch Changes
+
+- 7205137: fix: response body does not show a preview when the content-type is undefined
+- d369ac4: feat: union types in getExampleFromSchema
+
+## 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

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":"AAYA,iEAAiE;AACjE,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CAyBjB"}

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;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC,UACM,MAAM,KACZ,GA8OF,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,GA2PF,CAAA"}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { createHash } from './createHash';
 export { defaultStateFactory, ssrState } from './ssrState';
-export { fetchSpecFromUrl } from './fetch-spec';
+export { fetchSpecFromUrl } from './fetchSpecFromUrl';
 export { getExampleFromSchema } from './getExampleFromSchema';
 export { getHarRequest } from './getHarRequest';
 export { getParametersFromOperation } from './getParametersFromOperation';

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,mBAAmB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC1D,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,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"}
+{"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

@@ -86,25 +86,27 @@ const parseJsonOrYaml = (value) => {
   });
 };
 
+const OLD_PROXY_URL = "https://api.scalar.com/request-proxy";
+const NEW_PROXY_URL = "https://proxy.scalar.com";
+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);
+  if (proxy === OLD_PROXY_URL) {
+    proxy = NEW_PROXY_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) => {
@@ -263,6 +265,15 @@ const getExampleFromSchema = (schema, options, level = 0) => {
     });
     return example;
   }
+  if (Array.isArray(schema.type)) {
+    if (schema.type.includes("null")) {
+      return null;
+    }
+    const exampleValue = exampleValues[schema.type[0]];
+    if (exampleValue !== void 0) {
+      return exampleValue;
+    }
+  }
   console.warn(`[getExampleFromSchema] Unknown property type "${schema.type}".`);
   return null;
 };
@@ -377,6 +388,9 @@ function json2xml(data, tab) {
 }
 
 function normalizeMimeType(contentType) {
+  if (typeof contentType !== "string") {
+    return void 0;
+  }
   return contentType.replace(/;.*$/, "").replace(/\/.+\+/, "/").trim();
 }
 
@@ -389,6 +403,9 @@ function normalizeMimeTypeObject(content) {
   };
   Object.keys(newContent).forEach((key) => {
     const newKey = normalizeMimeType(key);
+    if (newKey === void 0) {
+      return;
+    }
     newContent[newKey] = newContent[key];
     if (key !== newKey) {
       delete newContent[key];

package/dist/normalizeMimeType.d.ts

@@ -1,3 +1,9 @@
 import type { ContentType } from './types';
-export declare function normalizeMimeType(contentType: string): ContentType;
+/**
+ * Normalizes a MIME type to a standard format.
+ *
+ * Input: application/problem+json; charset=utf-8
+ * Output: application/json
+ */
+export declare function normalizeMimeType(contentType?: string): ContentType | undefined;
 //# sourceMappingURL=normalizeMimeType.d.ts.map

package/dist/normalizeMimeType.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"normalizeMimeType.d.ts","sourceRoot":"","sources":["../src/normalizeMimeType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,CAAC,EAAE,MAAM,2BAcrD"}

package/dist/normalizeMimeTypeObject.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"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;;;;;;;;cA8BzE"}

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.12",
+  "version": "0.1.14",
   "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"}