vovk 3.0.0-draft.233 → 3.0.0-draft.235

package/cjs/openapi/vovkSchemaToOpenAPI.d.ts

@@ -1,9 +1,10 @@
 import type { OpenAPIObject } from 'openapi3-ts/oas31';
 import { type CodeSamplePackageJson } from '../utils/createCodeExamples';
-import { type VovkSchema } from '../types';
-export declare function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject, package: packageJson, }: {
+import { type VovkSchema, KnownAny } from '../types';
+export declare function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject, package: packageJson, sampler, }: {
     rootEntry: string;
     schema: VovkSchema;
     openAPIObject?: Partial<OpenAPIObject>;
     package?: CodeSamplePackageJson;
+    sampler?: (schema: KnownAny) => KnownAny;
 }): OpenAPIObject;

package/cjs/openapi/vovkSchemaToOpenAPI.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.vovkSchemaToOpenAPI = vovkSchemaToOpenAPI;
-const json_schema_sampler_1 = require("@stoplight/json-schema-sampler");
 const createCodeExamples_1 = require("../utils/createCodeExamples");
+const jsonSchemaSampler_1 = require("../utils/jsonSchemaSampler");
 const types_1 = require("../types");
 function extractComponents(schema) {
     if (!schema)
@@ -43,7 +43,7 @@ function extractComponents(schema) {
     const processedSchema = process(schema);
     return [processedSchema, components];
 }
-function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}, package: packageJson = { name: 'vovk-client' }, }) {
+function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}, package: packageJson = { name: 'vovk-client' }, sampler = jsonSchemaSampler_1.jsonSchemaSampler, }) {
     const paths = {};
     const components = {};
     for (const [segmentName, segmentSchema] of Object.entries(fullSchema.segments ?? {})) {
@@ -145,9 +145,9 @@ function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}
                                                     ...iterationValidation,
                                                     examples: iterationValidation.examples ?? [
                                                         [
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
                                                         ].join('\n'),
                                                     ],
                                                 },

package/cjs/utils/createCodeExamples.d.ts

@@ -7,11 +7,12 @@ export type CodeSamplePackageJson = {
     py_name?: string;
     [key: string]: KnownAny;
 };
-export declare function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, }: {
+export declare function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, sampler, }: {
     handlerName: string;
     handlerSchema: VovkHandlerSchema;
     controllerSchema: VovkControllerSchema;
     package?: CodeSamplePackageJson;
+    sampler?: (schema: KnownAny) => KnownAny;
 }): {
     ts: string;
     py: string;

package/cjs/utils/createCodeExamples.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCodeExamples = createCodeExamples;
-const json_schema_sampler_1 = require("@stoplight/json-schema-sampler");
+const jsonSchemaSampler_1 = require("./jsonSchemaSampler");
 const stringifyTsSample = (data, pad = 4) => JSON.stringify(data, null, 2)
     .replace(/"([A-Za-z_$][0-9A-Za-z_$]*)":/g, '$1:')
     .split('\n')
@@ -17,17 +17,17 @@ const toSnakeCase = (str) => str
     .replace(/([A-Z])([A-Z])(?=[a-z])/g, '$1_$2') // Add underscore between uppercase letters if the second one is followed by a lowercase
     .toLowerCase()
     .replace(/^_/, ''); // Remove leading underscore
-function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, }) {
+function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, sampler = jsonSchemaSampler_1.jsonSchemaSampler, }) {
     const queryValidation = handlerSchema?.validation?.query;
     const bodyValidation = handlerSchema?.validation?.body;
     const paramsValidation = handlerSchema?.validation?.params;
     const outputValidation = handlerSchema?.validation?.output;
     const iterationValidation = handlerSchema?.validation?.iteration;
-    const queryFake = queryValidation && (0, json_schema_sampler_1.sample)(queryValidation);
-    const bodyFake = bodyValidation && (0, json_schema_sampler_1.sample)(bodyValidation);
-    const paramsFake = paramsValidation && (0, json_schema_sampler_1.sample)(paramsValidation);
-    const outputFake = outputValidation && (0, json_schema_sampler_1.sample)(outputValidation);
-    const iterationFake = iterationValidation && (0, json_schema_sampler_1.sample)(iterationValidation);
+    const queryFake = queryValidation && sampler(queryValidation);
+    const bodyFake = bodyValidation && sampler(bodyValidation);
+    const paramsFake = paramsValidation && sampler(paramsValidation);
+    const outputFake = outputValidation && sampler(outputValidation);
+    const iterationFake = iterationValidation && sampler(iterationValidation);
     const hasArg = !!queryFake || !!bodyFake || !!paramsFake;
     const rpcName = controllerSchema.rpcModuleName;
     const handlerNameSnake = toSnakeCase(handlerName);

package/cjs/utils/jsonSchemaSampler.d.ts

@@ -0,0 +1,2 @@
+import { KnownAny } from '../types';
+export declare function jsonSchemaSampler(schema: KnownAny, rootSchema?: KnownAny): KnownAny;

package/cjs/utils/jsonSchemaSampler.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonSchemaSampler = jsonSchemaSampler;
+function jsonSchemaSampler(schema, rootSchema) {
+    // Use the input schema as the root if not provided
+    rootSchema = rootSchema || schema;
+    // If there's an example, use it
+    if (schema.example !== undefined) {
+        return schema.example;
+    }
+    // If there are examples, use one of them
+    if (schema.examples && schema.examples.length > 0) {
+        return schema.examples[0];
+    }
+    // Handle $ref if present
+    if (schema.$ref) {
+        return handleRef(schema.$ref, rootSchema);
+    }
+    // Handle enum if present
+    if (schema.enum && schema.enum.length > 0) {
+        return schema.enum[0];
+    }
+    // Handle oneOf, anyOf, allOf
+    if (schema.oneOf && schema.oneOf.length > 0) {
+        return jsonSchemaSampler(schema.oneOf[0], rootSchema);
+    }
+    if (schema.anyOf && schema.anyOf.length > 0) {
+        return jsonSchemaSampler(schema.anyOf[0], rootSchema);
+    }
+    if (schema.allOf && schema.allOf.length > 0) {
+        // Merge all schemas in allOf
+        const mergedSchema = schema.allOf.reduce((acc, s) => ({ ...acc, ...s }), {});
+        return jsonSchemaSampler(mergedSchema, rootSchema);
+    }
+    // Handle different types
+    if (schema.type) {
+        switch (schema.type) {
+            case 'string':
+                return handleString(schema);
+            case 'number':
+            case 'integer':
+                return handleNumber(schema);
+            case 'boolean':
+                return handleBoolean();
+            case 'object':
+                return handleObject(schema, rootSchema);
+            case 'array':
+                return handleArray(schema, rootSchema);
+            case 'null':
+                return null;
+            default:
+                return null;
+        }
+    }
+    // If type is not specified but properties are, treat it as an object
+    if (schema.properties) {
+        return handleObject(schema, rootSchema);
+    }
+    // Default fallback
+    return null;
+}
+function handleRef(ref, rootSchema) {
+    // Parse the reference path
+    const path = ref.split('/').slice(1); // Remove the initial '#'
+    // Navigate through the schema to find the referenced definition
+    let current = rootSchema;
+    for (const segment of path) {
+        current = current[segment];
+        if (current === undefined) {
+            return null; // Reference not found
+        }
+    }
+    // Process the referenced schema
+    return jsonSchemaSampler(current, rootSchema);
+}
+function handleString(schema) {
+    if (schema.format) {
+        switch (schema.format) {
+            case 'email':
+                return 'user@example.com';
+            case 'uri':
+            case 'url':
+                return 'https://example.com';
+            case 'date':
+                return '2023-01-01';
+            case 'date-time':
+                return '2023-01-01T00:00:00Z';
+            case 'uuid':
+                return '00000000-0000-0000-0000-000000000000';
+            default:
+                return 'string';
+        }
+    }
+    if (schema.pattern) {
+        // For simplicity, return a basic string for patterns
+        return 'pattern-string';
+    }
+    return 'string';
+}
+function handleNumber(schema) {
+    if (schema.minimum !== undefined && schema.maximum !== undefined) {
+        return schema.minimum;
+    }
+    else if (schema.minimum !== undefined) {
+        return schema.minimum;
+    }
+    else if (schema.maximum !== undefined) {
+        return schema.maximum;
+    }
+    return 0;
+}
+function handleBoolean() {
+    return true;
+}
+function handleObject(schema, rootSchema) {
+    const result = {};
+    if (schema.properties) {
+        const required = schema.required || [];
+        for (const [key, propSchema] of Object.entries(schema.properties)) {
+            // Only include required properties or as a basic example
+            if (required.includes(key) || required.length === 0) {
+                result[key] = jsonSchemaSampler(propSchema, rootSchema);
+            }
+        }
+    }
+    // Handle additionalProperties
+    if (schema.additionalProperties && typeof schema.additionalProperties === 'object') {
+        result['additionalProp'] = jsonSchemaSampler(schema.additionalProperties, rootSchema);
+    }
+    return result;
+}
+function handleArray(schema, rootSchema) {
+    if (schema.items) {
+        const itemSchema = schema.items;
+        const minItems = schema.minItems || 1;
+        // Create minimum number of items (capped at a reasonable max for examples)
+        const numItems = Math.min(minItems, 3);
+        return Array.from({ length: numItems }, () => jsonSchemaSampler(itemSchema, rootSchema));
+    }
+    return [];
+}

package/mjs/openapi/vovkSchemaToOpenAPI.d.ts

@@ -1,9 +1,10 @@
 import type { OpenAPIObject } from 'openapi3-ts/oas31';
 import { type CodeSamplePackageJson } from '../utils/createCodeExamples';
-import { type VovkSchema } from '../types';
-export declare function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject, package: packageJson, }: {
+import { type VovkSchema, KnownAny } from '../types';
+export declare function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject, package: packageJson, sampler, }: {
     rootEntry: string;
     schema: VovkSchema;
     openAPIObject?: Partial<OpenAPIObject>;
     package?: CodeSamplePackageJson;
+    sampler?: (schema: KnownAny) => KnownAny;
 }): OpenAPIObject;

package/mjs/openapi/vovkSchemaToOpenAPI.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.vovkSchemaToOpenAPI = vovkSchemaToOpenAPI;
-const json_schema_sampler_1 = require("@stoplight/json-schema-sampler");
 const createCodeExamples_1 = require("../utils/createCodeExamples");
+const jsonSchemaSampler_1 = require("../utils/jsonSchemaSampler");
 const types_1 = require("../types");
 function extractComponents(schema) {
     if (!schema)
@@ -43,7 +43,7 @@ function extractComponents(schema) {
     const processedSchema = process(schema);
     return [processedSchema, components];
 }
-function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}, package: packageJson = { name: 'vovk-client' }, }) {
+function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}, package: packageJson = { name: 'vovk-client' }, sampler = jsonSchemaSampler_1.jsonSchemaSampler, }) {
     const paths = {};
     const components = {};
     for (const [segmentName, segmentSchema] of Object.entries(fullSchema.segments ?? {})) {
@@ -145,9 +145,9 @@ function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, openAPIObject = {}
                                                     ...iterationValidation,
                                                     examples: iterationValidation.examples ?? [
                                                         [
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
-                                                            JSON.stringify((0, json_schema_sampler_1.sample)(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
+                                                            JSON.stringify(sampler(iterationValidation)),
                                                         ].join('\n'),
                                                     ],
                                                 },

package/mjs/utils/createCodeExamples.d.ts

@@ -7,11 +7,12 @@ export type CodeSamplePackageJson = {
     py_name?: string;
     [key: string]: KnownAny;
 };
-export declare function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, }: {
+export declare function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, sampler, }: {
     handlerName: string;
     handlerSchema: VovkHandlerSchema;
     controllerSchema: VovkControllerSchema;
     package?: CodeSamplePackageJson;
+    sampler?: (schema: KnownAny) => KnownAny;
 }): {
     ts: string;
     py: string;

package/mjs/utils/createCodeExamples.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCodeExamples = createCodeExamples;
-const json_schema_sampler_1 = require("@stoplight/json-schema-sampler");
+const jsonSchemaSampler_1 = require("./jsonSchemaSampler");
 const stringifyTsSample = (data, pad = 4) => JSON.stringify(data, null, 2)
     .replace(/"([A-Za-z_$][0-9A-Za-z_$]*)":/g, '$1:')
     .split('\n')
@@ -17,17 +17,17 @@ const toSnakeCase = (str) => str
     .replace(/([A-Z])([A-Z])(?=[a-z])/g, '$1_$2') // Add underscore between uppercase letters if the second one is followed by a lowercase
     .toLowerCase()
     .replace(/^_/, ''); // Remove leading underscore
-function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, }) {
+function createCodeExamples({ handlerName, handlerSchema, controllerSchema, package: packageJson, sampler = jsonSchemaSampler_1.jsonSchemaSampler, }) {
     const queryValidation = handlerSchema?.validation?.query;
     const bodyValidation = handlerSchema?.validation?.body;
     const paramsValidation = handlerSchema?.validation?.params;
     const outputValidation = handlerSchema?.validation?.output;
     const iterationValidation = handlerSchema?.validation?.iteration;
-    const queryFake = queryValidation && (0, json_schema_sampler_1.sample)(queryValidation);
-    const bodyFake = bodyValidation && (0, json_schema_sampler_1.sample)(bodyValidation);
-    const paramsFake = paramsValidation && (0, json_schema_sampler_1.sample)(paramsValidation);
-    const outputFake = outputValidation && (0, json_schema_sampler_1.sample)(outputValidation);
-    const iterationFake = iterationValidation && (0, json_schema_sampler_1.sample)(iterationValidation);
+    const queryFake = queryValidation && sampler(queryValidation);
+    const bodyFake = bodyValidation && sampler(bodyValidation);
+    const paramsFake = paramsValidation && sampler(paramsValidation);
+    const outputFake = outputValidation && sampler(outputValidation);
+    const iterationFake = iterationValidation && sampler(iterationValidation);
     const hasArg = !!queryFake || !!bodyFake || !!paramsFake;
     const rpcName = controllerSchema.rpcModuleName;
     const handlerNameSnake = toSnakeCase(handlerName);

package/mjs/utils/jsonSchemaSampler.d.ts

@@ -0,0 +1,2 @@
+import { KnownAny } from '../types';
+export declare function jsonSchemaSampler(schema: KnownAny, rootSchema?: KnownAny): KnownAny;

package/mjs/utils/jsonSchemaSampler.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonSchemaSampler = jsonSchemaSampler;
+function jsonSchemaSampler(schema, rootSchema) {
+    // Use the input schema as the root if not provided
+    rootSchema = rootSchema || schema;
+    // If there's an example, use it
+    if (schema.example !== undefined) {
+        return schema.example;
+    }
+    // If there are examples, use one of them
+    if (schema.examples && schema.examples.length > 0) {
+        return schema.examples[0];
+    }
+    // Handle $ref if present
+    if (schema.$ref) {
+        return handleRef(schema.$ref, rootSchema);
+    }
+    // Handle enum if present
+    if (schema.enum && schema.enum.length > 0) {
+        return schema.enum[0];
+    }
+    // Handle oneOf, anyOf, allOf
+    if (schema.oneOf && schema.oneOf.length > 0) {
+        return jsonSchemaSampler(schema.oneOf[0], rootSchema);
+    }
+    if (schema.anyOf && schema.anyOf.length > 0) {
+        return jsonSchemaSampler(schema.anyOf[0], rootSchema);
+    }
+    if (schema.allOf && schema.allOf.length > 0) {
+        // Merge all schemas in allOf
+        const mergedSchema = schema.allOf.reduce((acc, s) => ({ ...acc, ...s }), {});
+        return jsonSchemaSampler(mergedSchema, rootSchema);
+    }
+    // Handle different types
+    if (schema.type) {
+        switch (schema.type) {
+            case 'string':
+                return handleString(schema);
+            case 'number':
+            case 'integer':
+                return handleNumber(schema);
+            case 'boolean':
+                return handleBoolean();
+            case 'object':
+                return handleObject(schema, rootSchema);
+            case 'array':
+                return handleArray(schema, rootSchema);
+            case 'null':
+                return null;
+            default:
+                return null;
+        }
+    }
+    // If type is not specified but properties are, treat it as an object
+    if (schema.properties) {
+        return handleObject(schema, rootSchema);
+    }
+    // Default fallback
+    return null;
+}
+function handleRef(ref, rootSchema) {
+    // Parse the reference path
+    const path = ref.split('/').slice(1); // Remove the initial '#'
+    // Navigate through the schema to find the referenced definition
+    let current = rootSchema;
+    for (const segment of path) {
+        current = current[segment];
+        if (current === undefined) {
+            return null; // Reference not found
+        }
+    }
+    // Process the referenced schema
+    return jsonSchemaSampler(current, rootSchema);
+}
+function handleString(schema) {
+    if (schema.format) {
+        switch (schema.format) {
+            case 'email':
+                return 'user@example.com';
+            case 'uri':
+            case 'url':
+                return 'https://example.com';
+            case 'date':
+                return '2023-01-01';
+            case 'date-time':
+                return '2023-01-01T00:00:00Z';
+            case 'uuid':
+                return '00000000-0000-0000-0000-000000000000';
+            default:
+                return 'string';
+        }
+    }
+    if (schema.pattern) {
+        // For simplicity, return a basic string for patterns
+        return 'pattern-string';
+    }
+    return 'string';
+}
+function handleNumber(schema) {
+    if (schema.minimum !== undefined && schema.maximum !== undefined) {
+        return schema.minimum;
+    }
+    else if (schema.minimum !== undefined) {
+        return schema.minimum;
+    }
+    else if (schema.maximum !== undefined) {
+        return schema.maximum;
+    }
+    return 0;
+}
+function handleBoolean() {
+    return true;
+}
+function handleObject(schema, rootSchema) {
+    const result = {};
+    if (schema.properties) {
+        const required = schema.required || [];
+        for (const [key, propSchema] of Object.entries(schema.properties)) {
+            // Only include required properties or as a basic example
+            if (required.includes(key) || required.length === 0) {
+                result[key] = jsonSchemaSampler(propSchema, rootSchema);
+            }
+        }
+    }
+    // Handle additionalProperties
+    if (schema.additionalProperties && typeof schema.additionalProperties === 'object') {
+        result['additionalProp'] = jsonSchemaSampler(schema.additionalProperties, rootSchema);
+    }
+    return result;
+}
+function handleArray(schema, rootSchema) {
+    if (schema.items) {
+        const itemSchema = schema.items;
+        const minItems = schema.minItems || 1;
+        // Create minimum number of items (capped at a reasonable max for examples)
+        const numItems = Math.min(minItems, 3);
+        return Array.from({ length: numItems }, () => jsonSchemaSampler(itemSchema, rootSchema));
+    }
+    return [];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.233",
+  "version": "3.0.0-draft.235",
   "main": "./cjs/index.js",
   "module": "./mjs/index.js",
   "types": "./mjs/index.d.ts",
@@ -48,7 +48,6 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@stoplight/json-schema-sampler": "^0.3.0",
     "openapi3-ts": "^4.4.0"
   }
 }