vovk 3.0.0-draft.390 → 3.0.0-draft.392

package/cjs/utils/createCodeExamples.js

@@ -93,20 +93,8 @@ for await (const item of response) {
     return TS_CODE.trim();
 }
 function generatePythonCode({ handlerName, rpcName, packageName, queryValidation, bodyValidation, paramsValidation, outputValidation, iterationValidation, hasArg, }) {
-    const getPySample = (schema, indent) => (0, getJSONSchemaExample_1.getJSONSchemaExample)(schema, { stripQuotes: false, indent: indent ?? 4, comment: '#' });
+    const getPySample = (schema, indent) => (0, getJSONSchemaExample_1.getJSONSchemaExample)(schema, { stripQuotes: false, indent: indent ?? 4, comment: '#', ignoreBinary: true });
     const handlerNameSnake = toSnakeCase(handlerName);
-    const getPyData = (schema) => {
-        const noFileSchema = {
-            ...schema,
-            properties: schema.properties
-                ? Object.fromEntries(Object.entries(schema.properties).filter(([, prop]) => {
-                    const target = prop.oneOf?.[0] || prop.anyOf?.[0] || prop.allOf?.[0] || prop;
-                    return target.format !== 'binary' || target.items?.format !== 'binary';
-                }))
-                : {},
-        };
-        return getPySample(noFileSchema);
-    };
     const getFileTouple = (schema) => {
         return `('name.ext', BytesIO(${isTextFormat(schema.contentMediaType) ? '"text_content".encode("utf-8")' : 'binary_data'}${schema.contentMediaType ? `, "${schema.contentMediaType}"` : ''}))`;
     };
@@ -126,14 +114,14 @@ function generatePythonCode({ handlerName, rpcName, packageName, queryValidation
     };
     const pyFiles = bodyValidation ? getPyFiles(bodyValidation) : null;
     const pyFilesArg = pyFiles?.length
-        ? `${getIndentSpaces(4)}files=[\n${pyFiles.join(',\n')}${getIndentSpaces(4)}\n],`
+        ? `${getIndentSpaces(4)}files=[\n${pyFiles.join(',\n')}\n${getIndentSpaces(4)}],`
         : null;
     const PY_CODE = `from ${packageName} import ${rpcName}
 
 response = ${rpcName}.${handlerNameSnake}(${hasArg
         ? '\n' +
             [
-                bodyValidation ? `    body=${getPyData(bodyValidation)},` : null,
+                bodyValidation ? `    body=${getPySample(bodyValidation)},` : null,
                 pyFilesArg,
                 queryValidation ? `    query=${getPySample(queryValidation)},` : null,
                 paramsValidation ? `    params=${getPySample(paramsValidation)},` : null,

package/cjs/utils/getJSONSchemaExample.d.ts

@@ -3,7 +3,8 @@ interface SamplerOptions {
     comment?: '//' | '#';
     stripQuotes?: boolean;
     indent?: number;
+    ignoreBinary?: boolean;
 }
 export declare function getJSONSchemaExample(schema: VovkSimpleJSONSchema, options: SamplerOptions, rootSchema?: VovkSimpleJSONSchema): string;
-export declare function getSampleValue(schema: VovkSimpleJSONSchema, rootSchema?: VovkSimpleJSONSchema): KnownAny;
+export declare function getSampleValue(schema: VovkSimpleJSONSchema, rootSchema?: VovkSimpleJSONSchema, ignoreBinary?: boolean): KnownAny;
 export {};

package/cjs/utils/getJSONSchemaExample.js

@@ -3,20 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJSONSchemaExample = getJSONSchemaExample;
 exports.getSampleValue = getSampleValue;
 function getJSONSchemaExample(schema, options, rootSchema) {
-    const { comment = '//', stripQuotes = false, indent = 0 } = options;
+    const { comment = '//', stripQuotes = false, indent = 0, ignoreBinary = false } = options;
     if (!schema || typeof schema !== 'object')
         return 'null';
     // Use the input schema as the root if not provided
     rootSchema = rootSchema || schema;
     // Get the sample value
-    const sampleValue = getSampleValue(schema, rootSchema);
+    const sampleValue = getSampleValue(schema, rootSchema, ignoreBinary);
     // Format the output with descriptions
-    return formatWithDescriptions(sampleValue, schema, rootSchema, comment, stripQuotes, indent);
+    return formatWithDescriptions(sampleValue, schema, rootSchema, comment, stripQuotes, indent, ignoreBinary);
 }
-function getSampleValue(schema, rootSchema) {
+function getSampleValue(schema, rootSchema, ignoreBinary) {
     if (!schema || typeof schema !== 'object')
         return null;
     rootSchema = rootSchema || schema;
+    // Check if this is a binary string schema and should be ignored
+    if (ignoreBinary && schema.type === 'string' && schema.format === 'binary') {
+        return undefined;
+    }
     // If there's an example, use it
     if (schema.example !== undefined) {
         return schema.example;
@@ -31,7 +35,7 @@ function getSampleValue(schema, rootSchema) {
     }
     // Handle $ref if present
     if (schema.$ref) {
-        return handleRef(schema.$ref, rootSchema);
+        return handleRef(schema.$ref, rootSchema, ignoreBinary);
     }
     // Handle enum if present
     if (schema.enum && schema.enum.length > 0) {
@@ -39,15 +43,15 @@ function getSampleValue(schema, rootSchema) {
     }
     // Handle oneOf, anyOf, allOf
     if (schema.oneOf && schema.oneOf.length > 0) {
-        return getSampleValue(schema.oneOf[0], rootSchema);
+        return getSampleValue(schema.oneOf[0], rootSchema, ignoreBinary);
     }
     if (schema.anyOf && schema.anyOf.length > 0) {
-        return getSampleValue(schema.anyOf[0], rootSchema);
+        return getSampleValue(schema.anyOf[0], rootSchema, ignoreBinary);
     }
     if (schema.allOf && schema.allOf.length > 0) {
         // Merge all schemas in allOf
         const mergedSchema = schema.allOf.reduce((acc, s) => ({ ...acc, ...s }), {});
-        return getSampleValue(mergedSchema, rootSchema);
+        return getSampleValue(mergedSchema, rootSchema, ignoreBinary);
     }
     // Handle different types
     if (schema.type) {
@@ -60,9 +64,9 @@ function getSampleValue(schema, rootSchema) {
             case 'boolean':
                 return handleBoolean();
             case 'object':
-                return handleObject(schema, rootSchema);
+                return handleObject(schema, rootSchema, ignoreBinary);
             case 'array':
-                return handleArray(schema, rootSchema);
+                return handleArray(schema, rootSchema, ignoreBinary);
             case 'null':
                 return null;
             default:
@@ -71,13 +75,17 @@ function getSampleValue(schema, rootSchema) {
     }
     // If type is not specified but properties are, treat it as an object
     if (schema.properties) {
-        return handleObject(schema, rootSchema);
+        return handleObject(schema, rootSchema, ignoreBinary);
     }
     // Default fallback
     return null;
 }
-function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes, indent) {
+function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes, indent, ignoreBinary) {
     const indentStr = ' '.repeat(indent);
+    // Handle undefined (for ignored binary fields)
+    if (value === undefined) {
+        return '';
+    }
     // Handle null
     if (value === null) {
         return 'null';
@@ -92,7 +100,7 @@ function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes,
             return '[]';
         const items = value.map((item) => {
             const itemSchema = schema.items || {};
-            const formattedItem = formatWithDescriptions(item, itemSchema, rootSchema, comment, stripQuotes, indent + 4);
+            const formattedItem = formatWithDescriptions(item, itemSchema, rootSchema, comment, stripQuotes, indent + 4, ignoreBinary);
             return `${indentStr}  ${formattedItem}`;
         });
         return `[\n${items.join(',\n')}\n${indentStr}]`;
@@ -130,7 +138,7 @@ function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes,
             // Format the key
             const formattedKey = stripQuotes && /^[A-Za-z_$][0-9A-Za-z_$]*$/.test(key) ? key : JSON.stringify(key);
             // Format the value
-            const formattedValue = formatWithDescriptions(val, resolvedPropSchema, rootSchema, comment, stripQuotes, indent + 4);
+            const formattedValue = formatWithDescriptions(val, resolvedPropSchema, rootSchema, comment, stripQuotes, indent + 4, ignoreBinary);
             formattedEntries.push(`${indentStr}  ${formattedKey}: ${formattedValue}${index < entries.length - 1 ? ',' : ''}`);
         });
         return `{\n${formattedEntries.join('\n')}\n${indentStr}}`;
@@ -148,9 +156,9 @@ function resolveRef(ref, rootSchema) {
     }
     return current;
 }
-function handleRef(ref, rootSchema) {
+function handleRef(ref, rootSchema, ignoreBinary) {
     const resolved = resolveRef(ref, rootSchema);
-    return getSampleValue(resolved, rootSchema);
+    return getSampleValue(resolved, rootSchema, ignoreBinary);
 }
 function handleString(schema) {
     if (schema.format) {
@@ -186,6 +194,8 @@ function handleString(schema) {
                 return '+123-456-7890';
             case 'password':
                 return '******';
+            case 'binary':
+                return 'binary-data';
             default:
                 return 'string';
         }
@@ -210,27 +220,43 @@ function handleNumber(schema) {
 function handleBoolean() {
     return true;
 }
-function handleObject(schema, rootSchema) {
+function handleObject(schema, rootSchema, ignoreBinary) {
     const result = {};
     if (schema.properties) {
         const required = schema.required || [];
         for (const [key, propSchema] of Object.entries(schema.properties)) {
             if (required.includes(key) || required.length === 0) {
-                result[key] = getSampleValue(propSchema, rootSchema);
+                const value = getSampleValue(propSchema, rootSchema, ignoreBinary);
+                // Only add the property if it's not undefined (which happens when ignoreBinary is true and it's a binary field)
+                if (value !== undefined) {
+                    result[key] = value;
+                }
             }
         }
     }
     if (schema.additionalProperties && typeof schema.additionalProperties === 'object') {
-        result['additionalProp'] = getSampleValue(schema.additionalProperties, rootSchema);
+        const value = getSampleValue(schema.additionalProperties, rootSchema, ignoreBinary);
+        if (value !== undefined) {
+            result['additionalProp'] = value;
+        }
     }
     return result;
 }
-function handleArray(schema, rootSchema) {
+function handleArray(schema, rootSchema, ignoreBinary) {
     if (schema.items) {
         const itemSchema = schema.items;
+        // Check if the items are binary strings that should be ignored
+        if (ignoreBinary && itemSchema.type === 'string' && itemSchema.format === 'binary') {
+            return undefined;
+        }
         const minItems = schema.minItems || 1;
         const numItems = Math.min(minItems, 3);
-        return Array.from({ length: numItems }, () => getSampleValue(itemSchema, rootSchema));
+        const items = Array.from({ length: numItems }, () => getSampleValue(itemSchema, rootSchema, ignoreBinary)).filter((item) => item !== undefined); // Filter out undefined values from ignored binary items
+        // If all items were filtered out (e.g., all were binary), return undefined instead of empty array
+        if (items.length === 0 && numItems > 0) {
+            return undefined;
+        }
+        return items;
     }
     return [];
 }

package/mjs/utils/createCodeExamples.js

@@ -93,20 +93,8 @@ for await (const item of response) {
     return TS_CODE.trim();
 }
 function generatePythonCode({ handlerName, rpcName, packageName, queryValidation, bodyValidation, paramsValidation, outputValidation, iterationValidation, hasArg, }) {
-    const getPySample = (schema, indent) => (0, getJSONSchemaExample_1.getJSONSchemaExample)(schema, { stripQuotes: false, indent: indent ?? 4, comment: '#' });
+    const getPySample = (schema, indent) => (0, getJSONSchemaExample_1.getJSONSchemaExample)(schema, { stripQuotes: false, indent: indent ?? 4, comment: '#', ignoreBinary: true });
     const handlerNameSnake = toSnakeCase(handlerName);
-    const getPyData = (schema) => {
-        const noFileSchema = {
-            ...schema,
-            properties: schema.properties
-                ? Object.fromEntries(Object.entries(schema.properties).filter(([, prop]) => {
-                    const target = prop.oneOf?.[0] || prop.anyOf?.[0] || prop.allOf?.[0] || prop;
-                    return target.format !== 'binary' || target.items?.format !== 'binary';
-                }))
-                : {},
-        };
-        return getPySample(noFileSchema);
-    };
     const getFileTouple = (schema) => {
         return `('name.ext', BytesIO(${isTextFormat(schema.contentMediaType) ? '"text_content".encode("utf-8")' : 'binary_data'}${schema.contentMediaType ? `, "${schema.contentMediaType}"` : ''}))`;
     };
@@ -126,14 +114,14 @@ function generatePythonCode({ handlerName, rpcName, packageName, queryValidation
     };
     const pyFiles = bodyValidation ? getPyFiles(bodyValidation) : null;
     const pyFilesArg = pyFiles?.length
-        ? `${getIndentSpaces(4)}files=[\n${pyFiles.join(',\n')}${getIndentSpaces(4)}\n],`
+        ? `${getIndentSpaces(4)}files=[\n${pyFiles.join(',\n')}\n${getIndentSpaces(4)}],`
         : null;
     const PY_CODE = `from ${packageName} import ${rpcName}
 
 response = ${rpcName}.${handlerNameSnake}(${hasArg
         ? '\n' +
             [
-                bodyValidation ? `    body=${getPyData(bodyValidation)},` : null,
+                bodyValidation ? `    body=${getPySample(bodyValidation)},` : null,
                 pyFilesArg,
                 queryValidation ? `    query=${getPySample(queryValidation)},` : null,
                 paramsValidation ? `    params=${getPySample(paramsValidation)},` : null,

package/mjs/utils/getJSONSchemaExample.d.ts

@@ -3,7 +3,8 @@ interface SamplerOptions {
     comment?: '//' | '#';
     stripQuotes?: boolean;
     indent?: number;
+    ignoreBinary?: boolean;
 }
 export declare function getJSONSchemaExample(schema: VovkSimpleJSONSchema, options: SamplerOptions, rootSchema?: VovkSimpleJSONSchema): string;
-export declare function getSampleValue(schema: VovkSimpleJSONSchema, rootSchema?: VovkSimpleJSONSchema): KnownAny;
+export declare function getSampleValue(schema: VovkSimpleJSONSchema, rootSchema?: VovkSimpleJSONSchema, ignoreBinary?: boolean): KnownAny;
 export {};

package/mjs/utils/getJSONSchemaExample.js

@@ -3,20 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJSONSchemaExample = getJSONSchemaExample;
 exports.getSampleValue = getSampleValue;
 function getJSONSchemaExample(schema, options, rootSchema) {
-    const { comment = '//', stripQuotes = false, indent = 0 } = options;
+    const { comment = '//', stripQuotes = false, indent = 0, ignoreBinary = false } = options;
     if (!schema || typeof schema !== 'object')
         return 'null';
     // Use the input schema as the root if not provided
     rootSchema = rootSchema || schema;
     // Get the sample value
-    const sampleValue = getSampleValue(schema, rootSchema);
+    const sampleValue = getSampleValue(schema, rootSchema, ignoreBinary);
     // Format the output with descriptions
-    return formatWithDescriptions(sampleValue, schema, rootSchema, comment, stripQuotes, indent);
+    return formatWithDescriptions(sampleValue, schema, rootSchema, comment, stripQuotes, indent, ignoreBinary);
 }
-function getSampleValue(schema, rootSchema) {
+function getSampleValue(schema, rootSchema, ignoreBinary) {
     if (!schema || typeof schema !== 'object')
         return null;
     rootSchema = rootSchema || schema;
+    // Check if this is a binary string schema and should be ignored
+    if (ignoreBinary && schema.type === 'string' && schema.format === 'binary') {
+        return undefined;
+    }
     // If there's an example, use it
     if (schema.example !== undefined) {
         return schema.example;
@@ -31,7 +35,7 @@ function getSampleValue(schema, rootSchema) {
     }
     // Handle $ref if present
     if (schema.$ref) {
-        return handleRef(schema.$ref, rootSchema);
+        return handleRef(schema.$ref, rootSchema, ignoreBinary);
     }
     // Handle enum if present
     if (schema.enum && schema.enum.length > 0) {
@@ -39,15 +43,15 @@ function getSampleValue(schema, rootSchema) {
     }
     // Handle oneOf, anyOf, allOf
     if (schema.oneOf && schema.oneOf.length > 0) {
-        return getSampleValue(schema.oneOf[0], rootSchema);
+        return getSampleValue(schema.oneOf[0], rootSchema, ignoreBinary);
     }
     if (schema.anyOf && schema.anyOf.length > 0) {
-        return getSampleValue(schema.anyOf[0], rootSchema);
+        return getSampleValue(schema.anyOf[0], rootSchema, ignoreBinary);
     }
     if (schema.allOf && schema.allOf.length > 0) {
         // Merge all schemas in allOf
         const mergedSchema = schema.allOf.reduce((acc, s) => ({ ...acc, ...s }), {});
-        return getSampleValue(mergedSchema, rootSchema);
+        return getSampleValue(mergedSchema, rootSchema, ignoreBinary);
     }
     // Handle different types
     if (schema.type) {
@@ -60,9 +64,9 @@ function getSampleValue(schema, rootSchema) {
             case 'boolean':
                 return handleBoolean();
             case 'object':
-                return handleObject(schema, rootSchema);
+                return handleObject(schema, rootSchema, ignoreBinary);
             case 'array':
-                return handleArray(schema, rootSchema);
+                return handleArray(schema, rootSchema, ignoreBinary);
             case 'null':
                 return null;
             default:
@@ -71,13 +75,17 @@ function getSampleValue(schema, rootSchema) {
     }
     // If type is not specified but properties are, treat it as an object
     if (schema.properties) {
-        return handleObject(schema, rootSchema);
+        return handleObject(schema, rootSchema, ignoreBinary);
     }
     // Default fallback
     return null;
 }
-function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes, indent) {
+function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes, indent, ignoreBinary) {
     const indentStr = ' '.repeat(indent);
+    // Handle undefined (for ignored binary fields)
+    if (value === undefined) {
+        return '';
+    }
     // Handle null
     if (value === null) {
         return 'null';
@@ -92,7 +100,7 @@ function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes,
             return '[]';
         const items = value.map((item) => {
             const itemSchema = schema.items || {};
-            const formattedItem = formatWithDescriptions(item, itemSchema, rootSchema, comment, stripQuotes, indent + 4);
+            const formattedItem = formatWithDescriptions(item, itemSchema, rootSchema, comment, stripQuotes, indent + 4, ignoreBinary);
             return `${indentStr}  ${formattedItem}`;
         });
         return `[\n${items.join(',\n')}\n${indentStr}]`;
@@ -130,7 +138,7 @@ function formatWithDescriptions(value, schema, rootSchema, comment, stripQuotes,
             // Format the key
             const formattedKey = stripQuotes && /^[A-Za-z_$][0-9A-Za-z_$]*$/.test(key) ? key : JSON.stringify(key);
             // Format the value
-            const formattedValue = formatWithDescriptions(val, resolvedPropSchema, rootSchema, comment, stripQuotes, indent + 4);
+            const formattedValue = formatWithDescriptions(val, resolvedPropSchema, rootSchema, comment, stripQuotes, indent + 4, ignoreBinary);
             formattedEntries.push(`${indentStr}  ${formattedKey}: ${formattedValue}${index < entries.length - 1 ? ',' : ''}`);
         });
         return `{\n${formattedEntries.join('\n')}\n${indentStr}}`;
@@ -148,9 +156,9 @@ function resolveRef(ref, rootSchema) {
     }
     return current;
 }
-function handleRef(ref, rootSchema) {
+function handleRef(ref, rootSchema, ignoreBinary) {
     const resolved = resolveRef(ref, rootSchema);
-    return getSampleValue(resolved, rootSchema);
+    return getSampleValue(resolved, rootSchema, ignoreBinary);
 }
 function handleString(schema) {
     if (schema.format) {
@@ -186,6 +194,8 @@ function handleString(schema) {
                 return '+123-456-7890';
             case 'password':
                 return '******';
+            case 'binary':
+                return 'binary-data';
             default:
                 return 'string';
         }
@@ -210,27 +220,43 @@ function handleNumber(schema) {
 function handleBoolean() {
     return true;
 }
-function handleObject(schema, rootSchema) {
+function handleObject(schema, rootSchema, ignoreBinary) {
     const result = {};
     if (schema.properties) {
         const required = schema.required || [];
         for (const [key, propSchema] of Object.entries(schema.properties)) {
             if (required.includes(key) || required.length === 0) {
-                result[key] = getSampleValue(propSchema, rootSchema);
+                const value = getSampleValue(propSchema, rootSchema, ignoreBinary);
+                // Only add the property if it's not undefined (which happens when ignoreBinary is true and it's a binary field)
+                if (value !== undefined) {
+                    result[key] = value;
+                }
             }
         }
     }
     if (schema.additionalProperties && typeof schema.additionalProperties === 'object') {
-        result['additionalProp'] = getSampleValue(schema.additionalProperties, rootSchema);
+        const value = getSampleValue(schema.additionalProperties, rootSchema, ignoreBinary);
+        if (value !== undefined) {
+            result['additionalProp'] = value;
+        }
     }
     return result;
 }
-function handleArray(schema, rootSchema) {
+function handleArray(schema, rootSchema, ignoreBinary) {
     if (schema.items) {
         const itemSchema = schema.items;
+        // Check if the items are binary strings that should be ignored
+        if (ignoreBinary && itemSchema.type === 'string' && itemSchema.format === 'binary') {
+            return undefined;
+        }
         const minItems = schema.minItems || 1;
         const numItems = Math.min(minItems, 3);
-        return Array.from({ length: numItems }, () => getSampleValue(itemSchema, rootSchema));
+        const items = Array.from({ length: numItems }, () => getSampleValue(itemSchema, rootSchema, ignoreBinary)).filter((item) => item !== undefined); // Filter out undefined values from ignored binary items
+        // If all items were filtered out (e.g., all were binary), return undefined instead of empty array
+        if (items.length === 0 && numItems > 0) {
+            return undefined;
+        }
+        return items;
     }
     return [];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.390",
+  "version": "3.0.0-draft.392",
   "main": "./cjs/index.js",
   "module": "./mjs/index.js",
   "types": "./mjs/index.d.ts",