@scalar/oas-utils 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/oas-utils
 
+## 0.1.2
+
+### Patch Changes
+
+- 8b0691b: feat: added future support for SSR server state hydration
+
+## 0.1.1
+
+### Patch Changes
+
+- 31aae5e: chore: moved shared types and methods into oas-utils
+
 ## 0.1.0
 
 ### Minor Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Scalar
+Copyright (c) 2023-present Scalar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/getExampleFromSchema.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This function takes a properties object and generates an example response content.
+ */
+export declare const getExampleFromSchema: (schema: Record<string, any>, options?: {
+    /**
+     * The fallback string for empty string values.
+     * @default ''
+     **/
+    emptyString?: string;
+    /**
+     * Whether to use the XML tag names as keys
+     * @default false
+     */
+    xml?: boolean;
+    /**
+     * Whether to show read-only/write-only properties. Otherwise all properties are shown.
+     * @default undefined
+     */
+    mode?: 'read' | 'write';
+}, level?: number) => any;
+//# sourceMappingURL=getExampleFromSchema.d.ts.map

package/dist/getExampleFromSchema.d.ts.map

@@ -0,0 +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"}

package/dist/getHarRequest.d.ts

@@ -0,0 +1,4 @@
+import type { HarRequest } from 'httpsnippet-lite';
+import type { HarRequestWithPath } from './types';
+export declare const getHarRequest: (...requests: Partial<HarRequestWithPath>[]) => HarRequest;
+//# sourceMappingURL=getHarRequest.d.ts.map

package/dist/getHarRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getHarRequest.d.ts","sourceRoot":"","sources":["../src/getHarRequest.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,KAAK,EAAU,kBAAkB,EAAiB,MAAM,SAAS,CAAA;AAExE,eAAO,MAAM,aAAa,gBACX,QAAQ,kBAAkB,CAAC,EAAE,KACzC,UAsDF,CAAA"}

package/dist/getParametersFromOperation.d.ts

@@ -0,0 +1,11 @@
+import type { BaseParameter, TransformedOperation } from './types';
+/**
+ * Get the query parameters from an operation.
+ *
+ * Example: [ { name: 'foobar', value: '' } ]
+ *
+ * - OpenAPI 3.x: Possible values are “query”, “header”, “path” or “cookie”.
+ * - Swagger 2.0: Possible values are "query", "header", "path", "formData" or "body".
+ */
+export declare function getParametersFromOperation(operation: TransformedOperation, where: 'query' | 'header' | 'path' | 'cookie' | 'formData' | 'body', requiredOnly?: boolean): BaseParameter[];
+//# sourceMappingURL=getParametersFromOperation.d.ts.map

package/dist/getParametersFromOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getParametersFromOperation.d.ts","sourceRoot":"","sources":["../src/getParametersFromOperation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAElE;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAC/B,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,EACnE,YAAY,GAAE,OAAc,GAC3B,aAAa,EAAE,CAkCjB"}

package/dist/getRequestBodyFromOperation.d.ts

@@ -0,0 +1,86 @@
+import type { ContentType, TransformedOperation } from './types';
+/**
+ * Get the request body from the operation.
+ */
+export declare function getRequestBodyFromOperation(operation: TransformedOperation, selectedExampleKey?: string | number): {
+    postData: {
+        mimeType: string;
+        text: any;
+        params?: undefined;
+    };
+    headers?: undefined;
+} | {
+    postData: {
+        mimeType: string;
+        params: {
+            name: string;
+            value: string | number | Record<string, any>;
+        }[];
+        text?: undefined;
+    };
+    headers?: undefined;
+} | {
+    postData: undefined;
+    headers?: undefined;
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "application/json";
+        text: string;
+        params?: undefined;
+    };
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "application/xml";
+        text: any;
+        params?: undefined;
+    };
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "application/octet-stream";
+        text: string;
+        params?: undefined;
+    };
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "text/plain";
+        text: any;
+        params?: undefined;
+    };
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "application/x-www-form-urlencoded";
+        text?: undefined;
+        params?: undefined;
+    };
+} | {
+    headers: {
+        name: string;
+        value: ContentType;
+    }[];
+    postData: {
+        mimeType: "multipart/form-data";
+        text?: undefined;
+        params?: undefined;
+    };
+} | undefined;
+//# sourceMappingURL=getRequestBodyFromOperation.d.ts.map

package/dist/getRequestBodyFromOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../src/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEhE;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,oBAAoB,EAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAuNrC"}

package/dist/getRequestFromOperation.d.ts

@@ -0,0 +1,6 @@
+import type { HarRequestWithPath, TransformedOperation } from './types';
+export declare const getRequestFromOperation: (operation: TransformedOperation, options?: {
+    replaceVariables?: boolean;
+    requiredOnly?: boolean;
+}, selectedExampleKey?: string | number) => Partial<HarRequestWithPath>;
+//# sourceMappingURL=getRequestFromOperation.d.ts.map

package/dist/getRequestFromOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../src/getRequestFromOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,KACnC,QAAQ,kBAAkB,CAsC5B,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,12 @@
 export { fetchSpecFromUrl } from './fetch-spec';
-export * from './parse';
+export { getExampleFromSchema } from './getExampleFromSchema';
+export { getHarRequest } from './getHarRequest';
+export { getParametersFromOperation } from './getParametersFromOperation';
+export { getRequestBodyFromOperation } from './getRequestBodyFromOperation';
+export { getRequestFromOperation } from './getRequestFromOperation';
+export { json2xml } from './json2xml';
+export { formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml, } from './parse';
+export { prettyPrintJson } from './prettyPrintJson';
+export { defaultStateFactory, ssrState } from './ssrState';
 export * from './types';
 //# 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,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,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,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"}

package/dist/index.js

@@ -1,4 +1,5 @@
 import { parse, stringify } from 'yaml';
+import { AxiosHeaders } from 'axios';
 
 const yaml = {
   /** Parse and throw if the return value is not an object */
@@ -89,4 +90,456 @@ async function fetchSpecFromUrl(url, proxy) {
   return formatJsonOrYamlString(payload);
 }
 
-export { fetchSpecFromUrl, formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml };
+const getExampleFromSchema = (schema, options, level = 0) => {
+  if (level > 5) {
+    return null;
+  }
+  if (options?.mode === "write" && schema.readOnly) {
+    return void 0;
+  }
+  if (options?.mode === "read" && schema.writeOnly) {
+    return void 0;
+  }
+  if (Array.isArray(schema.examples) && schema.examples.length > 0) {
+    return schema.examples[0];
+  }
+  if (schema.example !== void 0) {
+    return schema.example;
+  }
+  if (schema.default !== void 0) {
+    return schema.default;
+  }
+  if (schema.enum !== void 0) {
+    return schema.enum[0];
+  }
+  if (schema.type === "object" || schema.properties !== void 0) {
+    const response = {};
+    if (schema.properties !== void 0) {
+      Object.keys(schema.properties).forEach((name) => {
+        const property = schema.properties[name];
+        const propertyXmlTagName = options?.xml ? property.xml?.name : void 0;
+        response[propertyXmlTagName ?? name] = getExampleFromSchema(
+          property,
+          options,
+          level + 1
+        );
+      });
+    }
+    if (schema.anyOf !== void 0) {
+      Object.assign(
+        response,
+        getExampleFromSchema(schema.anyOf[0]),
+        options,
+        level + 1
+      );
+    } else if (schema.oneOf !== void 0) {
+      Object.assign(
+        response,
+        getExampleFromSchema(schema.oneOf[0]),
+        options,
+        level + 1
+      );
+    } else if (schema.allOf !== void 0) {
+      Object.assign(
+        response,
+        ...schema.allOf.map(
+          (item) => getExampleFromSchema(item, options, level + 1)
+        )
+      );
+    }
+    if (schema.additionalProperties !== void 0 && schema.additionalProperties !== false) {
+      const additionalSchema = getExampleFromSchema(
+        schema.additionalProperties,
+        options,
+        level + 1
+      );
+      if (additionalSchema && typeof additionalSchema === "object" && !Array.isArray(additionalSchema)) {
+        return {
+          ...response,
+          ...getExampleFromSchema(
+            schema.additionalProperties,
+            options,
+            level + 1
+          )
+        };
+      }
+      if (additionalSchema === null) {
+        return null;
+      }
+      return {
+        ...response,
+        someKey: getExampleFromSchema(
+          schema.additionalProperties,
+          options,
+          level + 1
+        )
+      };
+    }
+    return response;
+  }
+  if (schema.type === "array" || schema.items !== void 0) {
+    const itemsXmlTagName = schema?.items?.xml?.name;
+    const wrapItems = !!(options?.xml && schema.xml?.wrapped && itemsXmlTagName);
+    if (schema.example !== void 0) {
+      return wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example;
+    }
+    if (schema.items) {
+      const rules = ["anyOf", "oneOf", "allOf"];
+      for (const rule of rules) {
+        if (!schema.items[rule]) {
+          continue;
+        }
+        const schemas = ["anyOf", "oneOf"].includes(rule) ? (
+          // Use the first item only
+          schema.items[rule].slice(0, 1)
+        ) : (
+          // Use all items
+          schema.items[rule]
+        );
+        const exampleFromRule = schemas.map(
+          (item) => getExampleFromSchema(item, options, level + 1)
+        );
+        return wrapItems ? [{ [itemsXmlTagName]: exampleFromRule }] : exampleFromRule;
+      }
+    }
+    if (schema.items?.type) {
+      const exampleFromSchema = getExampleFromSchema(
+        schema.items,
+        options,
+        level + 1
+      );
+      return wrapItems ? [{ [itemsXmlTagName]: exampleFromSchema }] : [exampleFromSchema];
+    }
+    return [];
+  }
+  const exampleValues = {
+    string: options?.emptyString ?? "",
+    boolean: true,
+    integer: schema.min ?? 1,
+    number: schema.min ?? 1,
+    array: []
+  };
+  if (schema.type !== void 0 && exampleValues[schema.type] !== void 0) {
+    return exampleValues[schema.type];
+  }
+  if (Array.isArray(schema.oneOf) && schema.oneOf.length > 0) {
+    const firstOneOfItem = schema.oneOf[0];
+    return getExampleFromSchema(firstOneOfItem, options, level + 1);
+  }
+  if (Array.isArray(schema.allOf)) {
+    let example = null;
+    schema.allOf.forEach((allOfItem) => {
+      const newExample = getExampleFromSchema(allOfItem, options, level + 1);
+      example = typeof newExample === "object" && typeof example === "object" ? {
+        ...example ?? {},
+        ...newExample
+      } : Array.isArray(newExample) && Array.isArray(example) ? [...example ?? {}, ...newExample] : newExample;
+    });
+    return example;
+  }
+  console.warn(`[getExampleFromSchema] Unknown property type "${schema.type}".`);
+  return null;
+};
+
+const getHarRequest = (...requests) => {
+  let mergedRequests = {
+    httpVersion: "1.1",
+    method: "GET",
+    url: "",
+    path: "",
+    headers: [],
+    headersSize: -1,
+    queryString: [],
+    cookies: [],
+    bodySize: -1
+  };
+  requests.forEach((request) => {
+    mergedRequests = {
+      ...mergedRequests,
+      ...request,
+      headers: [...mergedRequests.headers, ...request.headers ?? []],
+      queryString: [
+        ...mergedRequests.queryString,
+        ...request.queryString ?? []
+      ],
+      cookies: [...mergedRequests.cookies, ...request.cookies ?? []]
+    };
+  });
+  const headersObj = mergedRequests.headers.reduce(
+    (obj, { name, value }) => {
+      obj[name] = value;
+      return obj;
+    },
+    {}
+  );
+  const normalizedAxiosHeaders = AxiosHeaders.from(headersObj).normalize(true);
+  mergedRequests.headers = Object.entries(normalizedAxiosHeaders).map(
+    ([name, value]) => ({ name, value })
+  );
+  const { path, ...result } = mergedRequests;
+  if (path) {
+    return {
+      ...result,
+      url: `${mergedRequests.url}${path}`
+    };
+  }
+  return result;
+};
+
+function getParametersFromOperation(operation, where, requiredOnly = true) {
+  const parameters = [
+    ...operation.pathParameters || [],
+    ...operation.information?.parameters || []
+  ];
+  const params = parameters.filter((parameter) => parameter.in === where).filter(
+    (parameter) => requiredOnly && parameter.required || !requiredOnly
+  ).map((parameter) => ({
+    name: parameter.name,
+    description: parameter.description ?? null,
+    value: parameter.example ? parameter.example : parameter.schema ? getExampleFromSchema(parameter.schema, { mode: "write" }) : "",
+    required: parameter.required ?? false,
+    enabled: parameter.required ?? false
+  }));
+  return params.sort((a, b) => {
+    if (a.required && !b.required) {
+      return -1;
+    } else if (!a.required && b.required) {
+      return 1;
+    }
+    return 0;
+  });
+}
+
+function json2xml(data, tab) {
+  const toXml = function(value, key, indentation) {
+    let xml2 = "";
+    if (value instanceof Array) {
+      for (let i = 0, n = value.length; i < n; i++) {
+        xml2 += indentation + toXml(value[i], key, indentation + "	") + "\n";
+      }
+    } else if (typeof value == "object") {
+      let hasChild = false;
+      xml2 += indentation + "<" + key;
+      for (const m in value) {
+        if (m.charAt(0) == "@")
+          xml2 += " " + m.substr(1) + '="' + value[m].toString() + '"';
+        else
+          hasChild = true;
+      }
+      xml2 += hasChild ? ">" : "/>";
+      if (hasChild) {
+        for (const m in value) {
+          if (m == "#text")
+            xml2 += value[m];
+          else if (m == "#cdata")
+            xml2 += "<![CDATA[" + value[m] + "]]>";
+          else if (m.charAt(0) != "@")
+            xml2 += toXml(value[m], m, indentation + "	");
+        }
+        xml2 += (xml2.charAt(xml2.length - 1) == "\n" ? indentation : "") + "</" + key + ">";
+      }
+    } else {
+      xml2 += indentation + "<" + key + ">" + value.toString() + "</" + key + ">";
+    }
+    return xml2;
+  };
+  let xml = "";
+  for (const key in data) {
+    xml += toXml(data[key], key, "");
+  }
+  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}
+
+const prettyPrintJson = (value) => {
+  try {
+    if (typeof value === "string") {
+      return JSON.stringify(JSON.parse(value), null, 2);
+    } else {
+      return JSON.stringify(value, null, 2);
+    }
+  } catch {
+    console.log("[prettyPrintJson] Error parsing JSON", value);
+    return value;
+  }
+};
+
+function getRequestBodyFromOperation(operation, selectedExampleKey) {
+  const mimeTypes = [
+    "application/json",
+    "application/octet-stream",
+    "application/x-www-form-urlencoded",
+    "application/xml",
+    "multipart/form-data",
+    "text/plain"
+  ];
+  const mimeType = mimeTypes.find(
+    (currentMimeType) => !!operation.information?.requestBody?.content?.[currentMimeType]
+  );
+  const examples = operation.information?.requestBody?.content?.["application/json"]?.examples;
+  const selectedExample = (examples ?? {})?.[selectedExampleKey ?? Object.keys(examples ?? {})[0]];
+  if (selectedExample) {
+    return {
+      postData: {
+        mimeType: "application/json",
+        text: prettyPrintJson(selectedExample?.value)
+      }
+    };
+  }
+  const bodyParameters = getParametersFromOperation(operation, "body", false);
+  if (bodyParameters.length > 0) {
+    return {
+      postData: {
+        mimeType: "application/json",
+        text: prettyPrintJson(bodyParameters[0].value)
+      }
+    };
+  }
+  const formDataParameters = getParametersFromOperation(
+    operation,
+    "formData",
+    false
+  );
+  if (formDataParameters.length > 0) {
+    return {
+      postData: {
+        mimeType: "application/x-www-form-urlencoded",
+        params: formDataParameters.map((parameter) => ({
+          name: parameter.name,
+          value: parameter.value
+        }))
+      }
+    };
+  }
+  if (!mimeType) {
+    return {
+      postData: void 0
+    };
+  }
+  const requestBodyObject = operation.information?.requestBody?.content?.[mimeType];
+  const headers = [
+    {
+      name: "Content-Type",
+      value: mimeType
+    }
+  ];
+  const example = requestBodyObject?.example ? requestBodyObject?.example : void 0;
+  if (mimeType === "application/json") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, { mode: "write" }) : null;
+    const body = example ?? exampleFromSchema;
+    return {
+      headers,
+      postData: {
+        mimeType,
+        text: typeof body === "string" ? body : JSON.stringify(body, null, 2)
+      }
+    };
+  }
+  if (mimeType === "application/xml") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      xml: true,
+      mode: "write"
+    }) : null;
+    return {
+      headers,
+      postData: {
+        mimeType,
+        text: example ?? json2xml(exampleFromSchema, "  ")
+      }
+    };
+  }
+  if (mimeType === "application/octet-stream") {
+    return {
+      headers,
+      postData: {
+        mimeType,
+        text: "BINARY"
+      }
+    };
+  }
+  if (mimeType === "text/plain") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      xml: true,
+      mode: "write"
+    }) : null;
+    return {
+      headers,
+      postData: {
+        mimeType,
+        text: example ?? exampleFromSchema ?? ""
+      }
+    };
+  }
+  if (mimeType === "application/x-www-form-urlencoded") {
+    return {
+      headers,
+      postData: {
+        mimeType
+        // TODO: We have an object, but how do we get that kind of array from the object?
+        // Don’t forget to include nested properties … :|
+        // params: [
+        //   {
+        //     name: 'foo',
+        //     value: 'bar',
+        //   },
+        // ],
+      }
+    };
+  }
+  if (mimeType === "multipart/form-data") {
+    return {
+      headers,
+      postData: {
+        mimeType
+        // TODO: We have an object, but how do we get that kind of array from the object?
+        // Don’t forget to include nested properties … :|
+        // params: [
+        //   {
+        //     name: 'foo',
+        //     value: 'bar',
+        //   },
+        // ],
+      }
+    };
+  }
+  return void 0;
+}
+
+const getRequestFromOperation = (operation, options, selectedExampleKey) => {
+  let path = operation.path;
+  if (options?.replaceVariables === true) {
+    const pathVariables = path.match(/{(.*?)}/g);
+    if (pathVariables) {
+      pathVariables.forEach((variable) => {
+        const variableName = variable.replace(/{|}/g, "");
+        path = path.replace(variable, `__${variableName.toUpperCase()}__`);
+      });
+    }
+  }
+  const requestBody = getRequestBodyFromOperation(operation, selectedExampleKey);
+  return {
+    method: operation.httpVerb.toUpperCase(),
+    path,
+    headers: [
+      ...getParametersFromOperation(operation, "header", options?.requiredOnly),
+      ...requestBody?.headers ?? []
+    ],
+    // TODO: Sorry, something is off here and I don’t get it.
+    // @ts-ignore
+    postData: requestBody?.postData,
+    queryString: getParametersFromOperation(
+      operation,
+      "query",
+      options?.requiredOnly
+    ),
+    cookies: getParametersFromOperation(
+      operation,
+      "cookie",
+      options?.requiredOnly
+    )
+  };
+};
+
+const defaultStateFactory = () => ({});
+const ssrState = typeof window !== "undefined" ? window.__SCALAR__ ?? defaultStateFactory() : defaultStateFactory();
+
+export { defaultStateFactory, fetchSpecFromUrl, formatJsonOrYamlString, getExampleFromSchema, getHarRequest, getParametersFromOperation, getRequestBodyFromOperation, getRequestFromOperation, isJsonString, json, json2xml, parseJsonOrYaml, prettyPrintJson, ssrState, transformToJson, yaml };

package/dist/json2xml.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This function converts an object to XML.
+ */
+export declare function json2xml(data: Record<string, any>, tab?: string): string;
+//# sourceMappingURL=json2xml.d.ts.map

package/dist/json2xml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json2xml.d.ts","sourceRoot":"","sources":["../src/json2xml.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,UA+C/D"}

package/dist/prettyPrintJson.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Takes JSON and formats it.
+ **/
+export declare const prettyPrintJson: (value: any) => any;
+//# sourceMappingURL=prettyPrintJson.d.ts.map

package/dist/prettyPrintJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettyPrintJson.d.ts","sourceRoot":"","sources":["../src/prettyPrintJson.ts"],"names":[],"mappings":"AAAA;;IAEI;AACJ,eAAO,MAAM,eAAe,UAAW,GAAG,QAYzC,CAAA"}

package/dist/ssrState.d.ts

@@ -0,0 +1,12 @@
+import { type SSRState } from './types';
+declare global {
+    interface Window {
+        __SCALAR__: SSRState['scalarState'];
+    }
+}
+export declare const defaultStateFactory: () => SSRState['scalarState'];
+/**
+ * This allows us to access the server state in the front-end
+ */
+export declare const ssrState: SSRState['scalarState'];
+//# sourceMappingURL=ssrState.d.ts.map

package/dist/ssrState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssrState.d.ts","sourceRoot":"","sources":["../src/ssrState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAA;KACpC;CACF;AAED,eAAO,MAAM,mBAAmB,QAAO,QAAQ,CAAC,aAAa,CAAS,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAGlB,CAAA"}

package/dist/types.d.ts

@@ -1,3 +1,145 @@
+import type { OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
+import type { HarRequest } from 'httpsnippet-lite';
 export type AnyObject = Record<string, any>;
 export type AnyStringOrObject = string | Record<string, any>;
+export type BaseParameter = {
+    name: string;
+    description?: string | null;
+    value: string | number | Record<string, any>;
+    required?: boolean;
+    enabled: boolean;
+};
+export type ContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
+export type Cookie = {
+    name: string;
+    value: string;
+};
+export type CustomRequestExample = {
+    lang: string;
+    label: string;
+    source: string;
+};
+export type HarRequestWithPath = HarRequest & {
+    path: string;
+};
+export type Header = {
+    name: string;
+    value: string;
+};
+export type Information = {
+    'description'?: string;
+    'operationId'?: string | number;
+    'parameters'?: Parameters[];
+    'responses'?: Record<string, ScalarResponse>;
+    'security'?: OpenAPIV3.SecurityRequirementObject[];
+    'requestBody'?: RequestBody;
+    'summary'?: string;
+    'tags'?: string[];
+    'deprecated'?: boolean;
+    /**
+     * Scalar
+     **/
+    'x-custom-examples'?: CustomRequestExample[];
+    /**
+     * Redocly, current
+     **/
+    'x-codeSamples'?: CustomRequestExample[];
+    /**
+     * Redocly, deprecated
+     **/
+    'x-code-samples'?: CustomRequestExample[];
+};
+export type Operation = {
+    httpVerb: string;
+    path: string;
+    operationId?: string;
+    name?: string;
+    description?: string;
+    information?: Information;
+};
+export type Parameters = {
+    name: string;
+    in?: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: 'form' | 'simple';
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: Schema;
+    example?: any;
+    examples?: Map<string, any>;
+};
+export type Query = {
+    name: string;
+    value: string;
+};
+export type RequestBodyMimeTypes = {
+    [K in ContentType]?: {
+        schema?: any;
+        example?: any;
+        examples?: any;
+    };
+};
+export type ScalarResponse = {
+    description: string;
+    content: any;
+};
+export type RequestBody = {
+    description?: string;
+    required?: boolean;
+    content?: RequestBodyMimeTypes;
+};
+export type Schema = {
+    type: string;
+    name?: string;
+    example?: any;
+    default?: any;
+    format?: string;
+    description?: string;
+    properties?: Record<string, Schema>;
+};
+export type TransformedOperation = Operation & {
+    pathParameters?: Parameters[];
+};
+export type CollapsedSidebarItems = Record<string, boolean>;
+export type AuthenticationState = {
+    preferredSecurityScheme: string | null;
+    securitySchemes?: OpenAPIV3.ComponentsObject['securitySchemes'] | OpenAPIV3_1.ComponentsObject['securitySchemes'];
+    http: {
+        basic: {
+            username: string;
+            password: string;
+        };
+        bearer: {
+            token: string;
+        };
+    };
+    apiKey: {
+        token: string;
+    };
+    oAuth2: {
+        clientId: string;
+        scopes: string[];
+        accessToken: string;
+        state: string;
+    };
+};
+export type Heading = {
+    depth: number;
+    value: string;
+    slug?: string;
+};
+export type DescriptionSectionSSRKey = `components-Content-Introduction-Description-sections${number}`;
+export type SSRState = {
+    scalarState: {
+        'useGlobalStore-authentication'?: AuthenticationState;
+        'useSidebarContent-collapsedSidebarItems'?: CollapsedSidebarItems;
+        [key: DescriptionSectionSSRKey]: {
+            heading: Heading;
+            content: string;
+        }[];
+    };
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,0BAA0B,GAC1B,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC/B,YAAY,CAAC,EAAE,UAAU,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC5C,UAAU,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAClD,aAAa,CAAC,EAAE,WAAW,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;QAEI;IACJ,mBAAmB,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;QAEI;IACJ,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACxC;;QAEI;IACJ,gBAAgB,CAAC,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,UAAU,GAAG;IAEvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAGD,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE;QACnB,MAAM,CAAC,EAAE,GAAG,CAAA;QACZ,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,GAAG,CAAA;KACf;CACF,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,oBAAoB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAChC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,eAAe,CAAC,EACZ,SAAS,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,GAC7C,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,wBAAwB,GAClC,uDAAuD,MAAM,EAAE,CAAA;AAEjE,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE;QACX,+BAA+B,CAAC,EAAE,mBAAmB,CAAA;QACrD,yCAAyC,CAAC,EAAE,qBAAqB,CAAA;QACjE,CAAC,GAAG,EAAE,wBAAwB,GAAG;YAC/B,OAAO,EAAE,OAAO,CAAA;YAChB,OAAO,EAAE,MAAM,CAAA;SAChB,EAAE,CAAA;KACJ,CAAA;CACF,CAAA"}

package/package.json

@@ -11,7 +11,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.1.0",
+  "version": "0.1.2",
   "engines": {
     "node": ">=18"
   },
@@ -45,10 +45,13 @@
     "yaml": "^2.4.1"
   },
   "devDependencies": {
+    "@scalar/openapi-parser": "^0.3.2",
+    "axios": "^1.6.7",
+    "httpsnippet-lite": "^3.0.5",
     "tsc-alias": "^1.8.8",
     "vite": "^5.1.1",
     "vitest": "^1.2.2",
-    "@scalar/build-tooling": "0.1.0"
+    "@scalar/build-tooling": "0.1.1"
   },
   "scripts": {
     "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",