@scalar/oas-utils 0.1.13 → 0.1.15

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scalar/oas-utils
 
+## 0.1.15
+
+### Patch Changes
+
+- f472998: feat: generated example values based on the given format
+
+## 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

package/dist/fetchSpecFromUrl.d.ts.map

@@ -1 +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"}
+{"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":"AAsCA;;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,GAiQF,CAAA"}

package/dist/index.js

@@ -86,10 +86,15 @@ 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) {
+  if (proxy === OLD_PROXY_URL) {
+    proxy = NEW_PROXY_URL;
+  }
   const response = await fetch(proxy ? redirectToProxy(proxy, url) : url);
   if (response.status !== 200) {
     console.error(
@@ -104,10 +109,44 @@ async function fetchSpecFromUrl(url, proxy) {
   return formatJsonOrYamlString(await response.text());
 }
 
+function guessFromFormat(schema, fallback = "") {
+  const exampleValues = {
+    // 'date-time': '1970-01-01T00:00:00Z',
+    "date-time": (/* @__PURE__ */ new Date()).toISOString(),
+    // 'date': '1970-01-01',
+    "date": (/* @__PURE__ */ new Date()).toISOString().split("T")[0],
+    "email": "hello@example.com",
+    "hostname": "example.com",
+    // https://tools.ietf.org/html/rfc6531#section-3.3
+    "idn-email": "jane.doe@example.com",
+    // https://tools.ietf.org/html/rfc5890#section-2.3.2.3
+    "idn-hostname": "example.com",
+    "ipv4": "127.0.0.1",
+    "ipv6": "51d4:7fab:bfbf:b7d7:b2cb:d4b4:3dad:d998",
+    "iri-reference": "/entitiy/1",
+    // https://tools.ietf.org/html/rfc3987
+    "iri": "https://example.com/entity/123",
+    "json-pointer": "/nested/objects",
+    "password": "super-secret",
+    "regex": "/[a-z]/",
+    // https://tools.ietf.org/html/draft-handrews-relative-json-pointer-01
+    "relative-json-pointer": "1/nested/objects",
+    // full-time in https://tools.ietf.org/html/rfc3339#section-5.6
+    // 'time': '00:00:00Z',
+    "time": (/* @__PURE__ */ new Date()).toISOString().split("T")[1].split(".")[0],
+    // either a URI or relative-reference https://tools.ietf.org/html/rfc3986#section-4.1
+    "uri-reference": "../folder",
+    "uri-template": "https://example.com/{id}",
+    "uri": "https://example.com",
+    "uuid": "123e4567-e89b-12d3-a456-426614174000"
+  };
+  return exampleValues[schema.format] ?? fallback;
+}
 const getExampleFromSchema = (schema, options, level = 0) => {
   if (level > 5) {
     return null;
   }
+  const makeUpRandomData = !!options?.emptyString;
   if (options?.mode === "write" && schema.readOnly) {
     return void 0;
   }
@@ -236,7 +275,7 @@ const getExampleFromSchema = (schema, options, level = 0) => {
     return [];
   }
   const exampleValues = {
-    string: options?.emptyString ?? "",
+    string: makeUpRandomData ? guessFromFormat(schema, options?.emptyString) : "",
     boolean: true,
     integer: schema.min ?? 1,
     number: schema.min ?? 1,
@@ -260,6 +299,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;
 };
@@ -374,6 +422,9 @@ function json2xml(data, tab) {
 }
 
 function normalizeMimeType(contentType) {
+  if (typeof contentType !== "string") {
+    return void 0;
+  }
   return contentType.replace(/;.*$/, "").replace(/\/.+\+/, "/").trim();
 }
 
@@ -386,6 +437,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/package.json

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