@scalar/oas-utils 0.4.16 → 0.4.17

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/oas-utils
 
+## 0.4.17
+
+### Patch Changes
+
+- 46ebe6e: fix: use schema to example generator for request example request body
+- Updated dependencies [952bde2]
+- Updated dependencies [5301a80]
+- Updated dependencies [ae8d1b9]
+- Updated dependencies [8199955]
+- Updated dependencies [2888e18]
+  - @scalar/workspace-store@0.12.0
+
 ## 0.4.16
 
 ### Patch Changes

package/dist/helpers/operation-to-har/process-body.d.ts

@@ -1,4 +1,4 @@
-import type { OperationToHarProps } from '../../helpers/operation-to-har/operation-to-har.js';
+import type { OperationToHarProps } from './operation-to-har.js';
 import type { PostData } from 'har-format';
 type ProcessBodyProps = Pick<OperationToHarProps, 'contentType' | 'operation' | 'example'>;
 /**

package/dist/helpers/operation-to-har/process-body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"process-body.d.ts","sourceRoot":"","sources":["../../../src/helpers/operation-to-har/process-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAA;AAGtF,OAAO,KAAK,EAAS,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEjD,KAAK,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CAAA;AA0F1F;;GAEG;AACH,eAAO,MAAM,WAAW,wCAAyC,gBAAgB,KAAG,QA8CnF,CAAA"}
+{"version":3,"file":"process-body.d.ts","sourceRoot":"","sources":["../../../src/helpers/operation-to-har/process-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,OAAO,KAAK,EAAS,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEjD,KAAK,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CAAA;AAoC1F;;GAEG;AACH,eAAO,MAAM,WAAW,wCAAyC,gBAAgB,KAAG,QA6CnF,CAAA"}

package/dist/helpers/operation-to-har/process-body.js

@@ -1,32 +1,5 @@
+import { getExampleFromSchema } from "../../spec-getters/get-example-from-schema.js";
 import { isReference } from "@scalar/workspace-store/schemas/v3.1/type-guard";
-const extractExamplesFromSchema = (schema, depth = 0) => {
-  if (!schema || depth > 10) {
-    return void 0;
-  }
-  if (schema.examples?.[0] !== void 0) {
-    return schema.examples[0];
-  }
-  if (schema.example !== void 0) {
-    return schema.example;
-  }
-  if (schema.type === "object" && schema.properties) {
-    const result = {};
-    let hasExamples = false;
-    for (const [key, propSchema] of Object.entries(schema.properties)) {
-      const example = extractExamplesFromSchema(propSchema, depth + 1);
-      if (example !== void 0) {
-        result[key] = example;
-        hasExamples = true;
-      }
-    }
-    return hasExamples ? result : void 0;
-  }
-  if (schema.type === "array" && schema.items) {
-    const itemExample = extractExamplesFromSchema(schema.items, depth + 1);
-    return itemExample !== void 0 ? [itemExample] : void 0;
-  }
-  return void 0;
-};
 const objectToFormParams = (obj) => {
   const params = [];
   for (const [key, value] of Object.entries(obj)) {
@@ -50,7 +23,7 @@ const objectToFormParams = (obj) => {
 };
 const processBody = ({ operation, contentType, example }) => {
   const content = !operation.requestBody || isReference(operation.requestBody) ? {} : operation.requestBody.content;
-  const _contentType = contentType || Object.keys(content)[0];
+  const _contentType = (contentType || Object.keys(content)[0]) ?? "";
   const isFormData = _contentType === "multipart/form-data" || _contentType === "application/x-www-form-urlencoded";
   if (example) {
     if (isFormData && typeof example === "object" && example !== null) {
@@ -64,9 +37,9 @@ const processBody = ({ operation, contentType, example }) => {
       text: JSON.stringify(example)
     };
   }
-  const contentSchema = content[_contentType ?? ""]?.schema;
+  const contentSchema = content[_contentType]?.schema;
   if (contentSchema) {
-    const extractedExample = extractExamplesFromSchema(contentSchema);
+    const extractedExample = getExampleFromSchema(contentSchema);
     if (extractedExample !== void 0) {
       if (isFormData && typeof extractedExample === "object" && extractedExample !== null) {
         return {

package/dist/helpers/operation-to-har/process-body.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/helpers/operation-to-har/process-body.ts"],
-  "sourcesContent": ["import type { OperationToHarProps } from '@/helpers/operation-to-har/operation-to-har'\nimport type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/schema'\nimport { isReference } from '@scalar/workspace-store/schemas/v3.1/type-guard'\nimport type { Param, PostData } from 'har-format'\n\ntype ProcessBodyProps = Pick<OperationToHarProps, 'contentType' | 'operation' | 'example'>\n\n/**\n * Extended SchemaObject type that includes the examples property from JSON Schema\n */\ntype ExtendedSchemaObject = SchemaObject & {\n  examples?: unknown[]\n}\n\n/**\n * Recursively extracts examples from a schema object and its nested properties\n * @param schema - The schema object to extract examples from\n * @param depth - Current recursion depth to prevent infinite loops\n * @returns The extracted example or undefined if none found\n */\nconst extractExamplesFromSchema = (schema: ExtendedSchemaObject | undefined, depth = 0): unknown => {\n  // Prevent infinite recursion and handle invalid inputs\n  if (!schema || depth > 10) {\n    return undefined\n  }\n\n  // If the schema has examples array, return the first one\n  if (schema.examples?.[0] !== undefined) {\n    return schema.examples[0]\n  }\n\n  // If the schema has a single example property, return it\n  if (schema.example !== undefined) {\n    return schema.example\n  }\n\n  // For objects, recursively process properties\n  if (schema.type === 'object' && schema.properties) {\n    const result: Record<string, unknown> = {}\n    let hasExamples = false\n\n    for (const [key, propSchema] of Object.entries(schema.properties)) {\n      const example = extractExamplesFromSchema(propSchema as ExtendedSchemaObject, depth + 1)\n      if (example !== undefined) {\n        result[key] = example\n        hasExamples = true\n      }\n    }\n\n    return hasExamples ? result : undefined\n  }\n\n  // For arrays, process the items schema\n  if (schema.type === 'array' && schema.items) {\n    const itemExample = extractExamplesFromSchema(schema.items as ExtendedSchemaObject, depth + 1)\n    return itemExample !== undefined ? [itemExample] : undefined\n  }\n\n  return undefined\n}\n\n/**\n * Converts an object to an array of form parameters\n * @param obj - The object to convert\n * @returns Array of form parameters with name and value properties\n */\nconst objectToFormParams = (obj: Record<string, unknown>): Param[] => {\n  const params: Param[] = []\n\n  for (const [key, value] of Object.entries(obj)) {\n    if (value === undefined || value === null) {\n      continue\n    }\n\n    // Handle arrays by adding each item with the same key\n    if (Array.isArray(value)) {\n      for (const item of value) {\n        params.push({ name: key, value: String(item) })\n      }\n    }\n    // Handle nested objects by flattening them\n    else if (typeof value === 'object') {\n      const nestedParams = objectToFormParams(value as Record<string, unknown>)\n\n      for (const param of nestedParams) {\n        params.push({ name: `${key}.${param.name}`, value: param.value })\n      }\n    } else {\n      params.push({ name: key, value: String(value) })\n    }\n  }\n\n  return params\n}\n\n/**\n * Processes the request body and returns the processed data\n */\nexport const processBody = ({ operation, contentType, example }: ProcessBodyProps): PostData => {\n  const content = !operation.requestBody || isReference(operation.requestBody) ? {} : operation.requestBody.content\n\n  // TODO: This typecast is invalid and must be refactored out.\n  const _contentType = contentType || (Object.keys(content)[0] as string)\n\n  // Check if this is a form data content type\n  const isFormData = _contentType === 'multipart/form-data' || _contentType === 'application/x-www-form-urlencoded'\n\n  // Return the provided top level example\n  if (example) {\n    if (isFormData && typeof example === 'object' && example !== null) {\n      return {\n        mimeType: _contentType,\n        params: objectToFormParams(example as Record<string, unknown>),\n      }\n    }\n    return {\n      mimeType: _contentType,\n      text: JSON.stringify(example),\n    }\n  }\n\n  // Try to extract examples from the schema\n  const contentSchema = content[_contentType ?? '']?.schema\n  if (contentSchema) {\n    const extractedExample = extractExamplesFromSchema(contentSchema as ExtendedSchemaObject)\n\n    if (extractedExample !== undefined) {\n      if (isFormData && typeof extractedExample === 'object' && extractedExample !== null) {\n        return {\n          mimeType: _contentType,\n          params: objectToFormParams(extractedExample as Record<string, unknown>),\n        }\n      }\n      return {\n        mimeType: _contentType,\n        text: JSON.stringify(extractedExample),\n      }\n    }\n  }\n\n  return {\n    mimeType: _contentType,\n    text: 'null',\n  }\n}\n"],
-  "mappings": "AAEA,SAAS,mBAAmB;AAkB5B,MAAM,4BAA4B,CAAC,QAA0C,QAAQ,MAAe;AAElG,MAAI,CAAC,UAAU,QAAQ,IAAI;AACzB,WAAO;AAAA,EACT;AAGA,MAAI,OAAO,WAAW,CAAC,MAAM,QAAW;AACtC,WAAO,OAAO,SAAS,CAAC;AAAA,EAC1B;AAGA,MAAI,OAAO,YAAY,QAAW;AAChC,WAAO,OAAO;AAAA,EAChB;AAGA,MAAI,OAAO,SAAS,YAAY,OAAO,YAAY;AACjD,UAAM,SAAkC,CAAC;AACzC,QAAI,cAAc;AAElB,eAAW,CAAC,KAAK,UAAU,KAAK,OAAO,QAAQ,OAAO,UAAU,GAAG;AACjE,YAAM,UAAU,0BAA0B,YAAoC,QAAQ,CAAC;AACvF,UAAI,YAAY,QAAW;AACzB,eAAO,GAAG,IAAI;AACd,sBAAc;AAAA,MAChB;AAAA,IACF;AAEA,WAAO,cAAc,SAAS;AAAA,EAChC;AAGA,MAAI,OAAO,SAAS,WAAW,OAAO,OAAO;AAC3C,UAAM,cAAc,0BAA0B,OAAO,OAA+B,QAAQ,CAAC;AAC7F,WAAO,gBAAgB,SAAY,CAAC,WAAW,IAAI;AAAA,EACrD;AAEA,SAAO;AACT;AAOA,MAAM,qBAAqB,CAAC,QAA0C;AACpE,QAAM,SAAkB,CAAC;AAEzB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC;AAAA,IACF;AAGA,QAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,iBAAW,QAAQ,OAAO;AACxB,eAAO,KAAK,EAAE,MAAM,KAAK,OAAO,OAAO,IAAI,EAAE,CAAC;AAAA,MAChD;AAAA,IACF,WAES,OAAO,UAAU,UAAU;AAClC,YAAM,eAAe,mBAAmB,KAAgC;AAExE,iBAAW,SAAS,cAAc;AAChC,eAAO,KAAK,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,IAAI,IAAI,OAAO,MAAM,MAAM,CAAC;AAAA,MAClE;AAAA,IACF,OAAO;AACL,aAAO,KAAK,EAAE,MAAM,KAAK,OAAO,OAAO,KAAK,EAAE,CAAC;AAAA,IACjD;AAAA,EACF;AAEA,SAAO;AACT;AAKO,MAAM,cAAc,CAAC,EAAE,WAAW,aAAa,QAAQ,MAAkC;AAC9F,QAAM,UAAU,CAAC,UAAU,eAAe,YAAY,UAAU,WAAW,IAAI,CAAC,IAAI,UAAU,YAAY;AAG1G,QAAM,eAAe,eAAgB,OAAO,KAAK,OAAO,EAAE,CAAC;AAG3D,QAAM,aAAa,iBAAiB,yBAAyB,iBAAiB;AAG9E,MAAI,SAAS;AACX,QAAI,cAAc,OAAO,YAAY,YAAY,YAAY,MAAM;AACjE,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ,mBAAmB,OAAkC;AAAA,MAC/D;AAAA,IACF;AACA,WAAO;AAAA,MACL,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,OAAO;AAAA,IAC9B;AAAA,EACF;AAGA,QAAM,gBAAgB,QAAQ,gBAAgB,EAAE,GAAG;AACnD,MAAI,eAAe;AACjB,UAAM,mBAAmB,0BAA0B,aAAqC;AAExF,QAAI,qBAAqB,QAAW;AAClC,UAAI,cAAc,OAAO,qBAAqB,YAAY,qBAAqB,MAAM;AACnF,eAAO;AAAA,UACL,UAAU;AAAA,UACV,QAAQ,mBAAmB,gBAA2C;AAAA,QACxE;AAAA,MACF;AACA,aAAO;AAAA,QACL,UAAU;AAAA,QACV,MAAM,KAAK,UAAU,gBAAgB;AAAA,MACvC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU;AAAA,IACV,MAAM;AAAA,EACR;AACF;",
+  "sourcesContent": ["import type { OperationToHarProps } from './operation-to-har'\nimport { getExampleFromSchema } from '@/spec-getters/get-example-from-schema'\nimport { isReference } from '@scalar/workspace-store/schemas/v3.1/type-guard'\nimport type { Param, PostData } from 'har-format'\n\ntype ProcessBodyProps = Pick<OperationToHarProps, 'contentType' | 'operation' | 'example'>\n\n/**\n * Converts an object to an array of form parameters\n * @param obj - The object to convert\n * @returns Array of form parameters with name and value properties\n */\nconst objectToFormParams = (obj: Record<string, unknown>): Param[] => {\n  const params: Param[] = []\n\n  for (const [key, value] of Object.entries(obj)) {\n    if (value === undefined || value === null) {\n      continue\n    }\n\n    // Handle arrays by adding each item with the same key\n    if (Array.isArray(value)) {\n      for (const item of value) {\n        params.push({ name: key, value: String(item) })\n      }\n    }\n    // Handle nested objects by flattening them\n    else if (typeof value === 'object') {\n      const nestedParams = objectToFormParams(value as Record<string, unknown>)\n\n      for (const param of nestedParams) {\n        params.push({ name: `${key}.${param.name}`, value: param.value })\n      }\n    } else {\n      params.push({ name: key, value: String(value) })\n    }\n  }\n\n  return params\n}\n\n/**\n * Processes the request body and returns the processed data\n */\nexport const processBody = ({ operation, contentType, example }: ProcessBodyProps): PostData => {\n  const content = !operation.requestBody || isReference(operation.requestBody) ? {} : operation.requestBody.content\n\n  const _contentType = (contentType || Object.keys(content)[0]) ?? ''\n\n  // Check if this is a form data content type\n  const isFormData = _contentType === 'multipart/form-data' || _contentType === 'application/x-www-form-urlencoded'\n\n  // Return the provided top level example\n  if (example) {\n    if (isFormData && typeof example === 'object' && example !== null) {\n      return {\n        mimeType: _contentType,\n        params: objectToFormParams(example as Record<string, unknown>),\n      }\n    }\n    return {\n      mimeType: _contentType,\n      text: JSON.stringify(example),\n    }\n  }\n\n  // Try to extract examples from the schema\n  const contentSchema = content[_contentType]?.schema\n  if (contentSchema) {\n    const extractedExample = getExampleFromSchema(contentSchema)\n\n    if (extractedExample !== undefined) {\n      if (isFormData && typeof extractedExample === 'object' && extractedExample !== null) {\n        return {\n          mimeType: _contentType,\n          params: objectToFormParams(extractedExample as Record<string, unknown>),\n        }\n      }\n      return {\n        mimeType: _contentType,\n        text: JSON.stringify(extractedExample),\n      }\n    }\n  }\n\n  return {\n    mimeType: _contentType,\n    text: 'null',\n  }\n}\n"],
+  "mappings": "AACA,SAAS,4BAA4B;AACrC,SAAS,mBAAmB;AAU5B,MAAM,qBAAqB,CAAC,QAA0C;AACpE,QAAM,SAAkB,CAAC;AAEzB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,QAAI,UAAU,UAAa,UAAU,MAAM;AACzC;AAAA,IACF;AAGA,QAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,iBAAW,QAAQ,OAAO;AACxB,eAAO,KAAK,EAAE,MAAM,KAAK,OAAO,OAAO,IAAI,EAAE,CAAC;AAAA,MAChD;AAAA,IACF,WAES,OAAO,UAAU,UAAU;AAClC,YAAM,eAAe,mBAAmB,KAAgC;AAExE,iBAAW,SAAS,cAAc;AAChC,eAAO,KAAK,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,IAAI,IAAI,OAAO,MAAM,MAAM,CAAC;AAAA,MAClE;AAAA,IACF,OAAO;AACL,aAAO,KAAK,EAAE,MAAM,KAAK,OAAO,OAAO,KAAK,EAAE,CAAC;AAAA,IACjD;AAAA,EACF;AAEA,SAAO;AACT;AAKO,MAAM,cAAc,CAAC,EAAE,WAAW,aAAa,QAAQ,MAAkC;AAC9F,QAAM,UAAU,CAAC,UAAU,eAAe,YAAY,UAAU,WAAW,IAAI,CAAC,IAAI,UAAU,YAAY;AAE1G,QAAM,gBAAgB,eAAe,OAAO,KAAK,OAAO,EAAE,CAAC,MAAM;AAGjE,QAAM,aAAa,iBAAiB,yBAAyB,iBAAiB;AAG9E,MAAI,SAAS;AACX,QAAI,cAAc,OAAO,YAAY,YAAY,YAAY,MAAM;AACjE,aAAO;AAAA,QACL,UAAU;AAAA,QACV,QAAQ,mBAAmB,OAAkC;AAAA,MAC/D;AAAA,IACF;AACA,WAAO;AAAA,MACL,UAAU;AAAA,MACV,MAAM,KAAK,UAAU,OAAO;AAAA,IAC9B;AAAA,EACF;AAGA,QAAM,gBAAgB,QAAQ,YAAY,GAAG;AAC7C,MAAI,eAAe;AACjB,UAAM,mBAAmB,qBAAqB,aAAa;AAE3D,QAAI,qBAAqB,QAAW;AAClC,UAAI,cAAc,OAAO,qBAAqB,YAAY,qBAAqB,MAAM;AACnF,eAAO;AAAA,UACL,UAAU;AAAA,UACV,QAAQ,mBAAmB,gBAA2C;AAAA,QACxE;AAAA,MACF;AACA,aAAO;AAAA,QACL,UAAU;AAAA,QACV,MAAM,KAAK,UAAU,gBAAgB;AAAA,MACvC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU;AAAA,IACV,MAAM;AAAA,EACR;AACF;",
   "names": []
 }

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.4.16",
+  "version": "0.4.17",
   "engines": {
     "node": ">=20"
   },
@@ -99,11 +99,11 @@
     "type-fest": "4.41.0",
     "yaml": "2.8.0",
     "zod": "3.24.1",
+    "@scalar/helpers": "0.0.7",
     "@scalar/object-utils": "1.2.3",
     "@scalar/openapi-types": "0.3.7",
     "@scalar/themes": "0.13.12",
-    "@scalar/helpers": "0.0.7",
-    "@scalar/workspace-store": "0.11.0",
+    "@scalar/workspace-store": "0.12.0",
     "@scalar/types": "0.2.11"
   },
   "devDependencies": {
@@ -113,7 +113,7 @@
     "vitest": "^3.2.4",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.2.4",
-    "@scalar/openapi-parser": "0.18.3",
+    "@scalar/openapi-parser": "0.19.0",
     "@scalar/openapi-types": "0.3.7"
   },
   "scripts": {