@scalar/oas-utils 0.1.16 → 0.1.17

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.1.17
+
+### Patch Changes
+
+- c951512: feat: omit empty and not required properties from the generated request body
+
 ## 0.1.16
 
 ### Patch Changes

package/dist/getExampleFromSchema.d.ts

@@ -21,5 +21,9 @@ export declare const getExampleFromSchema: (schema: Record<string, any>, options
      * Dynamic values to add to the example.
      */
     variables?: Record<string, any>;
-}, level?: number) => any;
+    /**
+     * Whether to omit empty and optional properties.
+     */
+    omitEmptyAndOptionalProperties?: boolean;
+}, level?: number, parentSchema?: Record<string, any>, name?: string) => any;
 //# sourceMappingURL=getExampleFromSchema.d.ts.map

package/dist/getExampleFromSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../src/getExampleFromSchema.ts"],"names":[],"mappings":"AAsCA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC,UACM,MAAM,KACZ,GAiQF,CAAA"}
+{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../src/getExampleFromSchema.ts"],"names":[],"mappings":"AAsCA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,OAAO,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GAkSF,CAAA"}

package/dist/getRequestBodyFromOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../src/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAKA,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAwNrC"}
+{"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../src/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAKA,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA6NrC"}

package/dist/index.js

@@ -142,7 +142,7 @@ function guessFromFormat(schema, fallback = "") {
   };
   return exampleValues[schema.format] ?? fallback;
 }
-const getExampleFromSchema = (schema, options, level = 0) => {
+const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) => {
   if (level > 5) {
     return null;
   }
@@ -174,17 +174,29 @@ const getExampleFromSchema = (schema, options, level = 0) => {
   if (schema.enum !== void 0) {
     return schema.enum[0];
   }
+  const isObjectOrArray = schema.type === "object" || schema.type === "array";
+  if (!isObjectOrArray && options?.omitEmptyAndOptionalProperties === true) {
+    const isRequired = schema.required === true || parentSchema?.required === true || parentSchema?.required?.includes(name ?? schema.name);
+    if (!isRequired) {
+      return void 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];
+      Object.keys(schema.properties).forEach((propertyName) => {
+        const property = schema.properties[propertyName];
         const propertyXmlTagName = options?.xml ? property.xml?.name : void 0;
-        response[propertyXmlTagName ?? name] = getExampleFromSchema(
+        response[propertyXmlTagName ?? propertyName] = getExampleFromSchema(
           property,
           options,
-          level + 1
+          level + 1,
+          schema,
+          propertyName
         );
+        if (typeof response[propertyXmlTagName ?? propertyName] === "undefined") {
+          delete response[propertyXmlTagName ?? propertyName];
+        }
       });
     }
     if (schema.anyOf !== void 0) {
@@ -205,8 +217,8 @@ const getExampleFromSchema = (schema, options, level = 0) => {
       Object.assign(
         response,
         ...schema.allOf.map(
-          (item) => getExampleFromSchema(item, options, level + 1)
-        )
+          (item) => getExampleFromSchema(item, options, level + 1, schema)
+        ).filter((item) => item !== void 0)
       );
     }
     if (schema.additionalProperties !== void 0 && schema.additionalProperties !== false) {
@@ -228,13 +240,18 @@ const getExampleFromSchema = (schema, options, level = 0) => {
       if (additionalSchema === null) {
         return null;
       }
+      const additionalProperties = getExampleFromSchema(
+        schema.additionalProperties,
+        {
+          ...options,
+          // Let’s just add the additionalProperties, even if they are optional.
+          omitEmptyAndOptionalProperties: false
+        },
+        level + 1
+      );
       return {
         ...response,
-        someKey: getExampleFromSchema(
-          schema.additionalProperties,
-          options,
-          level + 1
-        )
+        ...additionalProperties === void 0 ? {} : { "{{key}}": additionalProperties }
       };
     }
     return response;
@@ -259,8 +276,8 @@ const getExampleFromSchema = (schema, options, level = 0) => {
           schema.items[rule]
         );
         const exampleFromRule = schemas.map(
-          (item) => getExampleFromSchema(item, options, level + 1)
-        );
+          (item) => getExampleFromSchema(item, options, level + 1, schema)
+        ).filter((item) => item !== void 0);
         return wrapItems ? [{ [itemsXmlTagName]: exampleFromRule }] : exampleFromRule;
       }
     }
@@ -524,7 +541,10 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
   ];
   const example = requestBodyObject?.example ? requestBodyObject?.example : void 0;
   if (mimeType === "application/json") {
-    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, { mode: "write" }) : null;
+    const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
+      mode: "write",
+      omitEmptyAndOptionalProperties: true
+    }) : null;
     const body = example ?? exampleFromSchema;
     return {
       headers,
@@ -537,7 +557,8 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
   if (mimeType === "application/xml") {
     const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
       xml: true,
-      mode: "write"
+      mode: "write",
+      omitEmptyAndOptionalProperties: true
     }) : null;
     return {
       headers,
@@ -559,7 +580,8 @@ function getRequestBodyFromOperation(operation, selectedExampleKey) {
   if (mimeType === "text/plain") {
     const exampleFromSchema = requestBodyObject?.schema ? getExampleFromSchema(requestBodyObject?.schema, {
       xml: true,
-      mode: "write"
+      mode: "write",
+      omitEmptyAndOptionalProperties: true
     }) : null;
     return {
       headers,

package/package.json

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