@scalar/oas-utils 0.1.10 → 0.1.12

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scalar/oas-utils
 
+## 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
+
+- 624604e: chore: move http status codes to oas-utils
+
 ## 0.1.10
 
 ### Patch Changes

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/httpStatusCodes.d.ts

@@ -0,0 +1,7 @@
+export type HttpStatusCode = {
+    name: string;
+    url: string;
+};
+export type HttpStatusCodes = Record<string, HttpStatusCode>;
+export declare const httpStatusCodes: HttpStatusCodes;
+//# sourceMappingURL=httpStatusCodes.d.ts.map

package/dist/httpStatusCodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpStatusCodes.d.ts","sourceRoot":"","sources":["../src/httpStatusCodes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAE5D,eAAO,MAAM,eAAe,EAAE,eAyP7B,CAAA"}

package/dist/index.d.ts

@@ -1,14 +1,17 @@
 export { createHash } from './createHash';
+export { defaultStateFactory, ssrState } from './ssrState';
 export { fetchSpecFromUrl } from './fetch-spec';
 export { getExampleFromSchema } from './getExampleFromSchema';
 export { getHarRequest } from './getHarRequest';
 export { getParametersFromOperation } from './getParametersFromOperation';
 export { getRequestBodyFromOperation } from './getRequestBodyFromOperation';
 export { getRequestFromOperation } from './getRequestFromOperation';
-export { normalizeMimeTypeObject } from './normalizeMimeTypeObject';
+export { httpStatusCodes } from './httpStatusCodes';
 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,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,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"}

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) => {
@@ -114,6 +117,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 +376,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 +388,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];
@@ -572,7 +588,255 @@ const getRequestFromOperation = (operation, options, selectedExampleKey) => {
   };
 };
 
-const defaultStateFactory = () => ({});
-const ssrState = typeof window !== "undefined" ? window.__SCALAR__ ?? defaultStateFactory() : defaultStateFactory();
+const httpStatusCodes = {
+  100: {
+    name: "Continue",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100"
+  },
+  101: {
+    name: "Switching Protocols",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101"
+  },
+  102: {
+    name: "Processing",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/102"
+  },
+  103: {
+    name: "Early Hints",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103"
+  },
+  200: {
+    name: "OK",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200"
+  },
+  201: {
+    name: "Created",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201"
+  },
+  202: {
+    name: "Accepted",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202"
+  },
+  203: {
+    name: "Non-Authoritative Information",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203"
+  },
+  204: {
+    name: "No Content",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204"
+  },
+  205: {
+    name: "Reset Content",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205"
+  },
+  206: {
+    name: "Partial Content",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206"
+  },
+  207: {
+    name: "Multi-Status",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/207"
+  },
+  208: {
+    name: "Already Reported",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/208"
+  },
+  226: {
+    name: "IM Used",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/226"
+  },
+  300: {
+    name: "Multiple Choices",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300"
+  },
+  301: {
+    name: "Moved Permanently",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301"
+  },
+  302: {
+    name: "Found",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302"
+  },
+  303: {
+    name: "See Other",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303"
+  },
+  304: {
+    name: "Not Modified",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304"
+  },
+  305: {
+    name: "Use Proxy",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/305"
+  },
+  306: {
+    name: "(Unused)",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/306"
+  },
+  307: {
+    name: "Temporary Redirect",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307"
+  },
+  308: {
+    name: "Permanent Redirect",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308"
+  },
+  400: {
+    name: "Bad Request",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400"
+  },
+  401: {
+    name: "Unauthorized",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401"
+  },
+  402: {
+    name: "Payment Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402"
+  },
+  403: {
+    name: "Forbidden",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403"
+  },
+  404: {
+    name: "Not Found",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404"
+  },
+  405: {
+    name: "Method Not Allowed",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405"
+  },
+  406: {
+    name: "Not Acceptable",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406"
+  },
+  407: {
+    name: "Proxy Authentication Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407"
+  },
+  408: {
+    name: "Request Timeout",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408"
+  },
+  409: {
+    name: "Conflict",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409"
+  },
+  410: {
+    name: "Gone",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410"
+  },
+  411: {
+    name: "Length Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411"
+  },
+  412: {
+    name: "Precondition Failed",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412"
+  },
+  413: {
+    name: "Content Too Large",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413"
+  },
+  414: {
+    name: "URI Too Long",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414"
+  },
+  415: {
+    name: "Unsupported Media Type",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415"
+  },
+  416: {
+    name: "Range Not Satisfiable",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416"
+  },
+  417: {
+    name: "Expectation Failed",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417"
+  },
+  421: {
+    name: "Misdirected Request",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/421"
+  },
+  422: {
+    name: "Unprocessable Content",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422"
+  },
+  423: {
+    name: "Locked",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/423"
+  },
+  424: {
+    name: "Failed Dependency",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/424"
+  },
+  425: {
+    name: "Too Early",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425"
+  },
+  426: {
+    name: "Upgrade Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426"
+  },
+  428: {
+    name: "Precondition Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428"
+  },
+  429: {
+    name: "Too Many Requests",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429"
+  },
+  431: {
+    name: "Request Header Fields Too Large",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431"
+  },
+  451: {
+    name: "Unavailable For Legal Reasons",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451"
+  },
+  500: {
+    name: "Internal Server Error",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500"
+  },
+  501: {
+    name: "Not Implemented",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501"
+  },
+  502: {
+    name: "Bad Gateway",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
+  },
+  503: {
+    name: "Service Unavailable",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503"
+  },
+  504: {
+    name: "Gateway Timeout",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504"
+  },
+  505: {
+    name: "HTTP Version Not Supported",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505"
+  },
+  506: {
+    name: "Variant Also Negotiates",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506"
+  },
+  507: {
+    name: "Insufficient Storage",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507"
+  },
+  508: {
+    name: "Loop Detected",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508"
+  },
+  510: {
+    name: "Not Extended",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510"
+  },
+  511: {
+    name: "Network Authentication Required",
+    url: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511"
+  }
+};
 
-export { createHash, defaultStateFactory, fetchSpecFromUrl, formatJsonOrYamlString, getExampleFromSchema, getHarRequest, getParametersFromOperation, getRequestBodyFromOperation, getRequestFromOperation, 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/package.json

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