@scalar/oas-utils 0.2.140 → 0.2.141

package/dist/spec-getters/get-request-body-from-operation.js

@@ -1,168 +1,116 @@
-import { json2xml } from '../helpers/json2xml.js';
-import { normalizeMimeTypeObject } from '../helpers/normalize-mime-type-object.js';
-import { prettyPrintJson } from '../helpers/pretty-print-json.js';
-import { getExampleFromSchema } from './get-example-from-schema.js';
-import { getParametersFromOperation } from './get-parameters-from-operation.js';
-
-/**
- * Transform the object into a nested array of objects
- * that represent the key-value pairs of the object.
- */
-function getParamsFromObject(obj, prefix = '') {
-    return Object.entries(obj).flatMap(([key, value]) => {
-        const newKey = prefix ? `${prefix}[${key}]` : key;
-        if (typeof value === 'object' && value !== null) {
-            return getParamsFromObject(value, newKey);
-        }
-        return [{ name: newKey, value }];
-    });
+import { json2xml } from "../helpers/json2xml.js";
+import { normalizeMimeTypeObject } from "../helpers/normalize-mime-type-object.js";
+import { prettyPrintJson } from "../helpers/pretty-print-json.js";
+import { getExampleFromSchema } from "./get-example-from-schema.js";
+import { getParametersFromOperation } from "./get-parameters-from-operation.js";
+function getParamsFromObject(obj, prefix = "") {
+  return Object.entries(obj).flatMap(([key, value]) => {
+    const newKey = prefix ? `${prefix}[${key}]` : key;
+    if (typeof value === "object" && value !== null) {
+      return getParamsFromObject(value, newKey);
+    }
+    return [{ name: newKey, value }];
+  });
 }
-// Define preferred standard mime types (order indicates preference)
 const standardMimeTypes = [
-    'application/json',
-    'application/octet-stream',
-    'application/x-www-form-urlencoded',
-    'application/xml',
-    'multipart/form-data',
-    'text/plain',
+  "application/json",
+  "application/octet-stream",
+  "application/x-www-form-urlencoded",
+  "application/xml",
+  "multipart/form-data",
+  "text/plain"
 ];
-/**
- * Get the request body from the operation.
- */
 function getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAndOptionalProperties) {
-    const originalContent = operation.information?.requestBody?.content;
-    const content = normalizeMimeTypeObject(originalContent);
-    // First try to find a standard mime type
-    const mimeType = standardMimeTypes.find((currentMimeType) => !!content?.[currentMimeType]) ??
-        (Object.keys(content ?? {})[0] || 'application/json');
-    // Handle JSON-like content types (e.g., application/vnd.github+json)
-    const isJsonLike = mimeType.includes('json') || mimeType.endsWith('+json');
-    /** Examples */
-    const examples = content?.[mimeType]?.examples ?? content?.['application/json']?.examples;
-    // Let’s use the first example
-    const selectedExample = examples?.[selectedExampleKey ?? Object.keys(examples ?? {})[0] ?? ''];
-    if (selectedExample) {
-        return {
-            mimeType,
-            text: prettyPrintJson(selectedExample?.value),
-        };
-    }
-    /**
-     * Body Parameters (Swagger 2.0)
-     *
-     * ”The payload that's appended to the HTTP request. Since there can only be one payload, there can only
-     * be one body parameter. The name of the body parameter has no effect on the parameter itself and is used
-     * for documentation purposes only. Since Form parameters are also in the payload, body and form
-     * parameters cannot exist together for the same operation.”
-     */
-    const bodyParameters = getParametersFromOperation(operation, 'body', false);
-    if (bodyParameters.length > 0) {
-        return {
-            mimeType: 'application/json',
-            text: prettyPrintJson(bodyParameters[0]?.value ?? ''),
-        };
-    }
-    /**
-     * FormData Parameters (Swagger 2.0)
-     *
-     * ”Form - Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded,
-     * multipart/form-data or both are used as the content type of the request (in Swagger's definition, the
-     * consumes property of an operation). This is the only parameter type that can be used to send files,
-     * thus supporting the file type. Since form parameters are sent in the payload, they cannot be declared
-     * together with a body parameter for the same operation. Form parameters have a different format based on
-     * the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
-     * - application/x-www-form-urlencoded - Similar to the format of Query parameters but as a payload.
-     *   For example, foo=1&bar=swagger - both foo and bar are form parameters. This is normally used for simple
-     *   parameters that are being transferred.
-     * - multipart/form-data - each parameter takes a section in the payload with an internal header.
-     *   For example, for the header Content-Disposition: form-data; name="submit-name" the name of the parameter is
-     *   submit-name. This type of form parameters is more commonly used for file transfers.”
-     */
-    const formDataParameters = getParametersFromOperation(operation, 'formData', false);
-    if (formDataParameters.length > 0) {
-        return {
-            mimeType: 'application/x-www-form-urlencoded',
-            params: formDataParameters.map((parameter) => ({
-                name: parameter.name,
-                /**
-                 * TODO: This value MUST be a string
-                 * Figure out why this is not always a string
-                 *
-                 * JSON.stringify is a TEMPORARY fix
-                 */
-                value: typeof parameter.value === 'string' ? parameter.value : JSON.stringify(parameter.value),
-            })),
-        };
-    }
-    // If no mime type is supported, exit early
-    if (!mimeType) {
-        return null;
-    }
-    // Get the request body object for the mime type
-    const requestBodyObject = content?.[mimeType];
-    // Get example from operation
-    const example = requestBodyObject?.example ? requestBodyObject?.example : undefined;
-    // Update the JSON handling section
-    if (isJsonLike) {
-        const exampleFromSchema = requestBodyObject?.schema
-            ? getExampleFromSchema(requestBodyObject?.schema, {
-                mode: 'write',
-                omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties ?? false,
-            })
-            : null;
-        const body = example ?? exampleFromSchema;
-        return {
-            mimeType,
-            text: body ? (typeof body === 'string' ? body : JSON.stringify(body, null, 2)) : undefined,
-        };
-    }
-    // XML
-    if (mimeType === 'application/xml') {
-        const exampleFromSchema = requestBodyObject?.schema
-            ? getExampleFromSchema(requestBodyObject?.schema, {
-                xml: true,
-                mode: 'write',
-            })
-            : null;
-        return {
-            mimeType,
-            text: example ?? json2xml(exampleFromSchema, '  '),
-        };
-    }
-    // Binary data
-    if (mimeType === 'application/octet-stream') {
-        return {
-            mimeType,
-            text: 'BINARY',
-        };
-    }
-    // Plain text
-    if (mimeType === 'text/plain') {
-        const exampleFromSchema = requestBodyObject?.schema
-            ? getExampleFromSchema(requestBodyObject?.schema, {
-                xml: true,
-                mode: 'write',
-            })
-            : null;
-        return {
-            mimeType,
-            text: example ?? exampleFromSchema ?? '',
-        };
-    }
-    // URL encoded data
-    if (mimeType === 'multipart/form-data' || mimeType === 'application/x-www-form-urlencoded') {
-        const exampleFromSchema = requestBodyObject?.schema
-            ? getExampleFromSchema(requestBodyObject?.schema, {
-                xml: true,
-                mode: 'write',
-            })
-            : null;
-        return {
-            mimeType,
-            params: getParamsFromObject(example ?? exampleFromSchema ?? {}),
-        };
-    }
+  const originalContent = operation.information?.requestBody?.content;
+  const content = normalizeMimeTypeObject(originalContent);
+  const mimeType = standardMimeTypes.find((currentMimeType) => !!content?.[currentMimeType]) ?? (Object.keys(content ?? {})[0] || "application/json");
+  const isJsonLike = mimeType.includes("json") || mimeType.endsWith("+json");
+  const examples = content?.[mimeType]?.examples ?? content?.["application/json"]?.examples;
+  const selectedExample = examples?.[selectedExampleKey ?? Object.keys(examples ?? {})[0] ?? ""];
+  if (selectedExample) {
+    return {
+      mimeType,
+      text: prettyPrintJson(selectedExample?.value)
+    };
+  }
+  const bodyParameters = getParametersFromOperation(operation, "body", false);
+  if (bodyParameters.length > 0) {
+    return {
+      mimeType: "application/json",
+      text: prettyPrintJson(bodyParameters[0]?.value ?? "")
+    };
+  }
+  const formDataParameters = getParametersFromOperation(operation, "formData", false);
+  if (formDataParameters.length > 0) {
+    return {
+      mimeType: "application/x-www-form-urlencoded",
+      params: formDataParameters.map((parameter) => ({
+        name: parameter.name,
+        /**
+         * TODO: This value MUST be a string
+         * Figure out why this is not always a string
+         *
+         * JSON.stringify is a TEMPORARY fix
+         */
+        value: typeof parameter.value === "string" ? parameter.value : JSON.stringify(parameter.value)
+      }))
+    };
+  }
+  if (!mimeType) {
     return null;
+  }
+  const requestBodyObject = content?.[mimeType];
+  const example = requestBodyObject?.example ? requestBodyObject?.example : void 0;
+  if (isJsonLike) {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      mode: "write",
+      omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties ?? false
+    }) : null;
+    const body = example ?? exampleFromSchema;
+    return {
+      mimeType,
+      text: body ? typeof body === "string" ? body : JSON.stringify(body, null, 2) : void 0
+    };
+  }
+  if (mimeType === "application/xml") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      xml: true,
+      mode: "write"
+    }) : null;
+    return {
+      mimeType,
+      text: example ?? json2xml(exampleFromSchema, "  ")
+    };
+  }
+  if (mimeType === "application/octet-stream") {
+    return {
+      mimeType,
+      text: "BINARY"
+    };
+  }
+  if (mimeType === "text/plain") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      xml: true,
+      mode: "write"
+    }) : null;
+    return {
+      mimeType,
+      text: example ?? exampleFromSchema ?? ""
+    };
+  }
+  if (mimeType === "multipart/form-data" || mimeType === "application/x-www-form-urlencoded") {
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      xml: true,
+      mode: "write"
+    }) : null;
+    return {
+      mimeType,
+      params: getParamsFromObject(example ?? exampleFromSchema ?? {})
+    };
+  }
+  return null;
 }
-
-export { getRequestBodyFromOperation };
+export {
+  getRequestBodyFromOperation
+};
+//# sourceMappingURL=get-request-body-from-operation.js.map

package/dist/spec-getters/get-request-body-from-operation.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/spec-getters/get-request-body-from-operation.ts"],
+  "sourcesContent": ["import type { ContentType, TransformedOperation } from '@scalar/types/legacy'\n\nimport { json2xml } from '@/helpers/json2xml'\nimport { normalizeMimeTypeObject } from '@/helpers/normalize-mime-type-object'\nimport { prettyPrintJson } from '@/helpers/pretty-print-json'\nimport { getExampleFromSchema } from './get-example-from-schema'\nimport { getParametersFromOperation } from './get-parameters-from-operation'\n\ntype AnyObject = Record<string, any>\n\n/**\n * Transform the object into a nested array of objects\n * that represent the key-value pairs of the object.\n */\nfunction getParamsFromObject(\n  obj: AnyObject,\n  prefix = '',\n): {\n  name: string\n  value: any\n}[] {\n  return Object.entries(obj).flatMap(([key, value]) => {\n    const newKey = prefix ? `${prefix}[${key}]` : key\n\n    if (typeof value === 'object' && value !== null) {\n      return getParamsFromObject(value, newKey)\n    }\n\n    return [{ name: newKey, value }]\n  })\n}\n// Define preferred standard mime types (order indicates preference)\nconst standardMimeTypes: ContentType[] = [\n  'application/json',\n  'application/octet-stream',\n  'application/x-www-form-urlencoded',\n  'application/xml',\n  'multipart/form-data',\n  'text/plain',\n]\n\n/**\n * Get the request body from the operation.\n */\nexport function getRequestBodyFromOperation(\n  operation: Omit<TransformedOperation, 'httpVerb'>,\n  selectedExampleKey?: string | number,\n  omitEmptyAndOptionalProperties?: boolean,\n): {\n  mimeType: ContentType\n  text?: string | undefined\n  params?: {\n    name: string\n    value?: string\n  }[]\n} | null {\n  const originalContent = operation.information?.requestBody?.content\n  const content = normalizeMimeTypeObject(originalContent)\n\n  // First try to find a standard mime type\n  const mimeType =\n    standardMimeTypes.find((currentMimeType) => !!content?.[currentMimeType]) ??\n    ((Object.keys(content ?? {})[0] || 'application/json') as ContentType)\n\n  // Handle JSON-like content types (e.g., application/vnd.github+json)\n  const isJsonLike = mimeType.includes('json') || mimeType.endsWith('+json')\n\n  /** Examples */\n  const examples = content?.[mimeType]?.examples ?? content?.['application/json']?.examples\n\n  // Let\u2019s use the first example\n  const selectedExample = examples?.[selectedExampleKey ?? Object.keys(examples ?? {})[0] ?? '']\n\n  if (selectedExample) {\n    return {\n      mimeType,\n      text: prettyPrintJson(selectedExample?.value),\n    }\n  }\n\n  /**\n   * Body Parameters (Swagger 2.0)\n   *\n   * \u201DThe payload that's appended to the HTTP request. Since there can only be one payload, there can only\n   * be one body parameter. The name of the body parameter has no effect on the parameter itself and is used\n   * for documentation purposes only. Since Form parameters are also in the payload, body and form\n   * parameters cannot exist together for the same operation.\u201D\n   */\n  const bodyParameters = getParametersFromOperation(operation, 'body', false)\n\n  if (bodyParameters.length > 0) {\n    return {\n      mimeType: 'application/json',\n      text: prettyPrintJson(bodyParameters[0]?.value ?? ''),\n    }\n  }\n\n  /**\n   * FormData Parameters (Swagger 2.0)\n   *\n   * \u201DForm - Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded,\n   * multipart/form-data or both are used as the content type of the request (in Swagger's definition, the\n   * consumes property of an operation). This is the only parameter type that can be used to send files,\n   * thus supporting the file type. Since form parameters are sent in the payload, they cannot be declared\n   * together with a body parameter for the same operation. Form parameters have a different format based on\n   * the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):\n   * - application/x-www-form-urlencoded - Similar to the format of Query parameters but as a payload.\n   *   For example, foo=1&bar=swagger - both foo and bar are form parameters. This is normally used for simple\n   *   parameters that are being transferred.\n   * - multipart/form-data - each parameter takes a section in the payload with an internal header.\n   *   For example, for the header Content-Disposition: form-data; name=\"submit-name\" the name of the parameter is\n   *   submit-name. This type of form parameters is more commonly used for file transfers.\u201D\n   */\n\n  const formDataParameters = getParametersFromOperation(operation, 'formData', false)\n\n  if (formDataParameters.length > 0) {\n    return {\n      mimeType: 'application/x-www-form-urlencoded',\n      params: formDataParameters.map((parameter) => ({\n        name: parameter.name,\n        /**\n         * TODO: This value MUST be a string\n         * Figure out why this is not always a string\n         *\n         * JSON.stringify is a TEMPORARY fix\n         */\n        value: typeof parameter.value === 'string' ? parameter.value : JSON.stringify(parameter.value),\n      })),\n    }\n  }\n\n  // If no mime type is supported, exit early\n  if (!mimeType) {\n    return null\n  }\n\n  // Get the request body object for the mime type\n  const requestBodyObject = content?.[mimeType]\n\n  // Get example from operation\n  const example = requestBodyObject?.example ? requestBodyObject?.example : undefined\n\n  // Update the JSON handling section\n  if (isJsonLike) {\n    const exampleFromSchema = requestBodyObject?.schema\n      ? getExampleFromSchema(requestBodyObject?.schema, {\n          mode: 'write',\n          omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties ?? false,\n        })\n      : null\n\n    const body = example ?? exampleFromSchema\n\n    return {\n      mimeType,\n      text: body ? (typeof body === 'string' ? body : JSON.stringify(body, null, 2)) : undefined,\n    }\n  }\n\n  // XML\n  if (mimeType === 'application/xml') {\n    const exampleFromSchema = requestBodyObject?.schema\n      ? getExampleFromSchema(requestBodyObject?.schema, {\n          xml: true,\n          mode: 'write',\n        })\n      : null\n\n    return {\n      mimeType,\n      text: example ?? json2xml(exampleFromSchema, '  '),\n    }\n  }\n\n  // Binary data\n  if (mimeType === 'application/octet-stream') {\n    return {\n      mimeType,\n      text: 'BINARY',\n    }\n  }\n\n  // Plain text\n  if (mimeType === 'text/plain') {\n    const exampleFromSchema = requestBodyObject?.schema\n      ? getExampleFromSchema(requestBodyObject?.schema, {\n          xml: true,\n          mode: 'write',\n        })\n      : null\n\n    return {\n      mimeType,\n      text: example ?? exampleFromSchema ?? '',\n    }\n  }\n\n  // URL encoded data\n  if (mimeType === 'multipart/form-data' || mimeType === 'application/x-www-form-urlencoded') {\n    const exampleFromSchema = requestBodyObject?.schema\n      ? getExampleFromSchema(requestBodyObject?.schema, {\n          xml: true,\n          mode: 'write',\n        })\n      : null\n\n    return {\n      mimeType,\n      params: getParamsFromObject(example ?? exampleFromSchema ?? {}),\n    }\n  }\n\n  return null\n}\n"],
+  "mappings": "AAEA,SAAS,gBAAgB;AACzB,SAAS,+BAA+B;AACxC,SAAS,uBAAuB;AAChC,SAAS,4BAA4B;AACrC,SAAS,kCAAkC;AAQ3C,SAAS,oBACP,KACA,SAAS,IAIP;AACF,SAAO,OAAO,QAAQ,GAAG,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AACnD,UAAM,SAAS,SAAS,GAAG,MAAM,IAAI,GAAG,MAAM;AAE9C,QAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,aAAO,oBAAoB,OAAO,MAAM;AAAA,IAC1C;AAEA,WAAO,CAAC,EAAE,MAAM,QAAQ,MAAM,CAAC;AAAA,EACjC,CAAC;AACH;AAEA,MAAM,oBAAmC;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAKO,SAAS,4BACd,WACA,oBACA,gCAQO;AACP,QAAM,kBAAkB,UAAU,aAAa,aAAa;AAC5D,QAAM,UAAU,wBAAwB,eAAe;AAGvD,QAAM,WACJ,kBAAkB,KAAK,CAAC,oBAAoB,CAAC,CAAC,UAAU,eAAe,CAAC,MACtE,OAAO,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK;AAGrC,QAAM,aAAa,SAAS,SAAS,MAAM,KAAK,SAAS,SAAS,OAAO;AAGzE,QAAM,WAAW,UAAU,QAAQ,GAAG,YAAY,UAAU,kBAAkB,GAAG;AAGjF,QAAM,kBAAkB,WAAW,sBAAsB,OAAO,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE;AAE7F,MAAI,iBAAiB;AACnB,WAAO;AAAA,MACL;AAAA,MACA,MAAM,gBAAgB,iBAAiB,KAAK;AAAA,IAC9C;AAAA,EACF;AAUA,QAAM,iBAAiB,2BAA2B,WAAW,QAAQ,KAAK;AAE1E,MAAI,eAAe,SAAS,GAAG;AAC7B,WAAO;AAAA,MACL,UAAU;AAAA,MACV,MAAM,gBAAgB,eAAe,CAAC,GAAG,SAAS,EAAE;AAAA,IACtD;AAAA,EACF;AAmBA,QAAM,qBAAqB,2BAA2B,WAAW,YAAY,KAAK;AAElF,MAAI,mBAAmB,SAAS,GAAG;AACjC,WAAO;AAAA,MACL,UAAU;AAAA,MACV,QAAQ,mBAAmB,IAAI,CAAC,eAAe;AAAA,QAC7C,MAAM,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOhB,OAAO,OAAO,UAAU,UAAU,WAAW,UAAU,QAAQ,KAAK,UAAU,UAAU,KAAK;AAAA,MAC/F,EAAE;AAAA,IACJ;AAAA,EACF;AAGA,MAAI,CAAC,UAAU;AACb,WAAO;AAAA,EACT;AAGA,QAAM,oBAAoB,UAAU,QAAQ;AAG5C,QAAM,UAAU,mBAAmB,UAAU,mBAAmB,UAAU;AAG1E,MAAI,YAAY;AACd,UAAM,oBAAoB,mBAAmB,SACzC,qBAAqB,mBAAmB,QAAQ;AAAA,MAC9C,MAAM;AAAA,MACN,gCAAgC,kCAAkC;AAAA,IACpE,CAAC,IACD;AAEJ,UAAM,OAAO,WAAW;AAExB,WAAO;AAAA,MACL;AAAA,MACA,MAAM,OAAQ,OAAO,SAAS,WAAW,OAAO,KAAK,UAAU,MAAM,MAAM,CAAC,IAAK;AAAA,IACnF;AAAA,EACF;AAGA,MAAI,aAAa,mBAAmB;AAClC,UAAM,oBAAoB,mBAAmB,SACzC,qBAAqB,mBAAmB,QAAQ;AAAA,MAC9C,KAAK;AAAA,MACL,MAAM;AAAA,IACR,CAAC,IACD;AAEJ,WAAO;AAAA,MACL;AAAA,MACA,MAAM,WAAW,SAAS,mBAAmB,IAAI;AAAA,IACnD;AAAA,EACF;AAGA,MAAI,aAAa,4BAA4B;AAC3C,WAAO;AAAA,MACL;AAAA,MACA,MAAM;AAAA,IACR;AAAA,EACF;AAGA,MAAI,aAAa,cAAc;AAC7B,UAAM,oBAAoB,mBAAmB,SACzC,qBAAqB,mBAAmB,QAAQ;AAAA,MAC9C,KAAK;AAAA,MACL,MAAM;AAAA,IACR,CAAC,IACD;AAEJ,WAAO;AAAA,MACL;AAAA,MACA,MAAM,WAAW,qBAAqB;AAAA,IACxC;AAAA,EACF;AAGA,MAAI,aAAa,yBAAyB,aAAa,qCAAqC;AAC1F,UAAM,oBAAoB,mBAAmB,SACzC,qBAAqB,mBAAmB,QAAQ;AAAA,MAC9C,KAAK;AAAA,MACL,MAAM;AAAA,IACR,CAAC,IACD;AAEJ,WAAO;AAAA,MACL;AAAA,MACA,QAAQ,oBAAoB,WAAW,qBAAqB,CAAC,CAAC;AAAA,IAChE;AAAA,EACF;AAEA,SAAO;AACT;",
+  "names": []
+}

package/dist/spec-getters/get-request-body-from-operation.test.js

@@ -0,0 +1,289 @@
+import { describe, expect, it } from "vitest";
+import { getRequestBodyFromOperation } from "./get-request-body-from-operation.js";
+describe("getRequestBodyFromOperation", () => {
+  it("creates a JSON body from a requestBody schema", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "integer",
+                    example: 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      id: 1
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("ignores charset in mimetypes", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          content: {
+            "application/json; charset=utf-8": {
+              schema: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "integer",
+                    example: 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      id: 1
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("creates a JSON body from body parameters", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        parameters: [
+          {
+            name: "body",
+            in: "body",
+            schema: {
+              type: "object",
+              properties: {
+                id: {
+                  name: "id",
+                  type: "integer",
+                  example: 1
+                }
+              }
+            }
+          }
+        ]
+      }
+    });
+    const expectedResult = {
+      id: 1
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("uses example", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          description: "Sample request body",
+          required: false,
+          content: {
+            "application/json": {
+              example: {
+                someObject: {
+                  someAttribute: "attribute1"
+                }
+              },
+              schema: {
+                $ref: "#/components/schemas/PutDocumentRequest"
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      someObject: {
+        someAttribute: "attribute1"
+      }
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("uses examples", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          description: "Sample request body",
+          required: false,
+          content: {
+            "application/json": {
+              examples: {
+                "request-example-1": {
+                  summary: "an example of a request",
+                  description: "a longer string than the summary",
+                  value: {
+                    someObject: {
+                      someAttribute: "attribute1"
+                    }
+                  }
+                }
+              },
+              schema: {
+                $ref: "#/components/schemas/PutDocumentRequest"
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      someObject: {
+        someAttribute: "attribute1"
+      }
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("creates key-value pair examples from object schema", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          description: "Sample request body",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                required: [
+                  "recordString",
+                  "recordInteger",
+                  "recordArray",
+                  "recordBoolean",
+                  "recordNullable",
+                  "recordObject",
+                  "recordWithoutAdditionalProperties"
+                ],
+                properties: {
+                  recordString: {
+                    type: "string"
+                  },
+                  recordInteger: {
+                    type: "integer"
+                  },
+                  recordArray: {
+                    type: "array"
+                  },
+                  recordBoolean: {
+                    type: "boolean"
+                  },
+                  recordNullable: {
+                    nullable: "true"
+                  },
+                  recordObject: {
+                    type: "object"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      recordString: "",
+      recordInteger: 1,
+      recordArray: [],
+      recordBoolean: true,
+      recordNullable: null,
+      recordObject: {}
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+  it("adds parameters from a requestBody schema", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          content: {
+            "application/x-www-form-urlencoded": {
+              schema: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "integer",
+                    example: 1
+                  },
+                  name: {
+                    type: "string",
+                    example: "foobar"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    expect(body).toMatchObject({
+      mimeType: "application/x-www-form-urlencoded",
+      params: [
+        {
+          name: "id",
+          value: 1
+        },
+        {
+          name: "name",
+          value: "foobar"
+        }
+      ]
+    });
+  });
+  it("handles vendor-specific MIME types", () => {
+    const body = getRequestBodyFromOperation({
+      path: "/foobar",
+      information: {
+        requestBody: {
+          content: {
+            "application/vnd.github+json": {
+              schema: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "integer",
+                    example: 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    });
+    const expectedResult = {
+      id: 1
+    };
+    expect(body).toMatchObject({
+      mimeType: "application/vnd.github+json",
+      text: JSON.stringify(expectedResult, null, 2)
+    });
+  });
+});
+//# sourceMappingURL=get-request-body-from-operation.test.js.map

package/dist/spec-getters/get-request-body-from-operation.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/spec-getters/get-request-body-from-operation.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { getRequestBodyFromOperation } from './get-request-body-from-operation'\n\ndescribe('getRequestBodyFromOperation', () => {\n  it('creates a JSON body from a requestBody schema', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          content: {\n            'application/json': {\n              schema: {\n                type: 'object',\n                properties: {\n                  id: {\n                    type: 'integer',\n                    example: 1,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      id: 1,\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('ignores charset in mimetypes', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          content: {\n            'application/json; charset=utf-8': {\n              schema: {\n                type: 'object',\n                properties: {\n                  id: {\n                    type: 'integer',\n                    example: 1,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      id: 1,\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('creates a JSON body from body parameters', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        parameters: [\n          {\n            name: 'body',\n            in: 'body',\n            schema: {\n              type: 'object',\n              properties: {\n                id: {\n                  name: 'id',\n                  type: 'integer',\n                  example: 1,\n                },\n              },\n            },\n          },\n        ],\n      },\n    })\n\n    const expectedResult = {\n      id: 1,\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('uses example', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          description: 'Sample request body',\n          required: false,\n          content: {\n            'application/json': {\n              example: {\n                someObject: {\n                  someAttribute: 'attribute1',\n                },\n              },\n              schema: {\n                $ref: '#/components/schemas/PutDocumentRequest',\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      someObject: {\n        someAttribute: 'attribute1',\n      },\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('uses examples', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          description: 'Sample request body',\n          required: false,\n          content: {\n            'application/json': {\n              examples: {\n                'request-example-1': {\n                  summary: 'an example of a request',\n                  description: 'a longer string than the summary',\n                  value: {\n                    someObject: {\n                      someAttribute: 'attribute1',\n                    },\n                  },\n                },\n              },\n              schema: {\n                $ref: '#/components/schemas/PutDocumentRequest',\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      someObject: {\n        someAttribute: 'attribute1',\n      },\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('creates key-value pair examples from object schema', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          description: 'Sample request body',\n          content: {\n            'application/json': {\n              schema: {\n                type: 'object',\n                required: [\n                  'recordString',\n                  'recordInteger',\n                  'recordArray',\n                  'recordBoolean',\n                  'recordNullable',\n                  'recordObject',\n                  'recordWithoutAdditionalProperties',\n                ],\n                properties: {\n                  recordString: {\n                    type: 'string',\n                  },\n                  recordInteger: {\n                    type: 'integer',\n                  },\n                  recordArray: {\n                    type: 'array',\n                  },\n                  recordBoolean: {\n                    type: 'boolean',\n                  },\n                  recordNullable: {\n                    nullable: 'true',\n                  },\n                  recordObject: {\n                    type: 'object',\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      recordString: '',\n      recordInteger: 1,\n      recordArray: [],\n      recordBoolean: true,\n      recordNullable: null,\n      recordObject: {},\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n\n  it('adds parameters from a requestBody schema', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          content: {\n            'application/x-www-form-urlencoded': {\n              schema: {\n                type: 'object',\n                properties: {\n                  id: {\n                    type: 'integer',\n                    example: 1,\n                  },\n                  name: {\n                    type: 'string',\n                    example: 'foobar',\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    })\n\n    expect(body).toMatchObject({\n      mimeType: 'application/x-www-form-urlencoded',\n      params: [\n        {\n          name: 'id',\n          value: 1,\n        },\n        {\n          name: 'name',\n          value: 'foobar',\n        },\n      ],\n    })\n  })\n\n  it('handles vendor-specific MIME types', () => {\n    const body = getRequestBodyFromOperation({\n      path: '/foobar',\n      information: {\n        requestBody: {\n          content: {\n            'application/vnd.github+json': {\n              schema: {\n                type: 'object',\n                properties: {\n                  id: {\n                    type: 'integer',\n                    example: 1,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    })\n\n    const expectedResult = {\n      id: 1,\n    }\n\n    expect(body).toMatchObject({\n      mimeType: 'application/vnd.github+json',\n      text: JSON.stringify(expectedResult, null, 2),\n    })\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,mCAAmC;AAE5C,SAAS,+BAA+B,MAAM;AAC5C,KAAG,iDAAiD,MAAM;AACxD,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,SAAS;AAAA,YACP,oBAAoB;AAAA,cAClB,QAAQ;AAAA,gBACN,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,IAAI;AAAA,oBACF,MAAM;AAAA,oBACN,SAAS;AAAA,kBACX;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,gCAAgC,MAAM;AACvC,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,SAAS;AAAA,YACP,mCAAmC;AAAA,cACjC,QAAQ;AAAA,gBACN,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,IAAI;AAAA,oBACF,MAAM;AAAA,oBACN,SAAS;AAAA,kBACX;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,4CAA4C,MAAM;AACnD,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,YAAY;AAAA,UACV;AAAA,YACE,MAAM;AAAA,YACN,IAAI;AAAA,YACJ,QAAQ;AAAA,cACN,MAAM;AAAA,cACN,YAAY;AAAA,gBACV,IAAI;AAAA,kBACF,MAAM;AAAA,kBACN,MAAM;AAAA,kBACN,SAAS;AAAA,gBACX;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,gBAAgB,MAAM;AACvB,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,aAAa;AAAA,UACb,UAAU;AAAA,UACV,SAAS;AAAA,YACP,oBAAoB;AAAA,cAClB,SAAS;AAAA,gBACP,YAAY;AAAA,kBACV,eAAe;AAAA,gBACjB;AAAA,cACF;AAAA,cACA,QAAQ;AAAA,gBACN,MAAM;AAAA,cACR;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,YAAY;AAAA,QACV,eAAe;AAAA,MACjB;AAAA,IACF;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,iBAAiB,MAAM;AACxB,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,aAAa;AAAA,UACb,UAAU;AAAA,UACV,SAAS;AAAA,YACP,oBAAoB;AAAA,cAClB,UAAU;AAAA,gBACR,qBAAqB;AAAA,kBACnB,SAAS;AAAA,kBACT,aAAa;AAAA,kBACb,OAAO;AAAA,oBACL,YAAY;AAAA,sBACV,eAAe;AAAA,oBACjB;AAAA,kBACF;AAAA,gBACF;AAAA,cACF;AAAA,cACA,QAAQ;AAAA,gBACN,MAAM;AAAA,cACR;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,YAAY;AAAA,QACV,eAAe;AAAA,MACjB;AAAA,IACF;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,sDAAsD,MAAM;AAC7D,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,aAAa;AAAA,UACb,SAAS;AAAA,YACP,oBAAoB;AAAA,cAClB,QAAQ;AAAA,gBACN,MAAM;AAAA,gBACN,UAAU;AAAA,kBACR;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,gBACF;AAAA,gBACA,YAAY;AAAA,kBACV,cAAc;AAAA,oBACZ,MAAM;AAAA,kBACR;AAAA,kBACA,eAAe;AAAA,oBACb,MAAM;AAAA,kBACR;AAAA,kBACA,aAAa;AAAA,oBACX,MAAM;AAAA,kBACR;AAAA,kBACA,eAAe;AAAA,oBACb,MAAM;AAAA,kBACR;AAAA,kBACA,gBAAgB;AAAA,oBACd,UAAU;AAAA,kBACZ;AAAA,kBACA,cAAc;AAAA,oBACZ,MAAM;AAAA,kBACR;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,cAAc;AAAA,MACd,eAAe;AAAA,MACf,aAAa,CAAC;AAAA,MACd,eAAe;AAAA,MACf,gBAAgB;AAAA,MAChB,cAAc,CAAC;AAAA,IACjB;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AAED,KAAG,6CAA6C,MAAM;AACpD,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,SAAS;AAAA,YACP,qCAAqC;AAAA,cACnC,QAAQ;AAAA,gBACN,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,IAAI;AAAA,oBACF,MAAM;AAAA,oBACN,SAAS;AAAA,kBACX;AAAA,kBACA,MAAM;AAAA,oBACJ,MAAM;AAAA,oBACN,SAAS;AAAA,kBACX;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,QAAQ;AAAA,QACN;AAAA,UACE,MAAM;AAAA,UACN,OAAO;AAAA,QACT;AAAA,QACA;AAAA,UACE,MAAM;AAAA,UACN,OAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,sCAAsC,MAAM;AAC7C,UAAM,OAAO,4BAA4B;AAAA,MACvC,MAAM;AAAA,MACN,aAAa;AAAA,QACX,aAAa;AAAA,UACX,SAAS;AAAA,YACP,+BAA+B;AAAA,cAC7B,QAAQ;AAAA,gBACN,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,IAAI;AAAA,oBACF,MAAM;AAAA,oBACN,SAAS;AAAA,kBACX;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,cAAc;AAAA,MACzB,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,gBAAgB,MAAM,CAAC;AAAA,IAC9C,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/spec-getters/get-server-variable-examples.d.ts

@@ -1,4 +1,4 @@
-import type { Server } from '../entities/spec/server.ts';
+import type { Server } from '../entities/spec/server.js';
 /** Retrieve example values for server variables */
 export declare const getServerVariableExamples: (server: Server) => Record<string, string[]>;
 //# sourceMappingURL=get-server-variable-examples.d.ts.map

package/dist/spec-getters/get-server-variable-examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-server-variable-examples.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-server-variable-examples.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,mDAAmD;AACnD,eAAO,MAAM,yBAAyB,WAAY,MAAM,6BAUvD,CAAA"}
+{"version":3,"file":"get-server-variable-examples.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-server-variable-examples.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAEpD,mDAAmD;AACnD,eAAO,MAAM,yBAAyB,WAAY,MAAM,6BAUvD,CAAA"}