reliant-type 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +1305 -0
- package/dist/cjs/constants/SECURITY_CONSTANTS.js +49 -0
- package/dist/cjs/constants/SECURITY_CONSTANTS.js.map +1 -0
- package/dist/cjs/constants/VALIDATION_CONSTANTS.js +103 -0
- package/dist/cjs/constants/VALIDATION_CONSTANTS.js.map +1 -0
- package/dist/cjs/core/schema/extensions/SmartInference.js +200 -0
- package/dist/cjs/core/schema/extensions/SmartInference.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/Docs.js +100 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/Docs.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js +192 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.js +174 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/SchemaAnalyzer.js +54 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/SchemaAnalyzer.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/TypeScriptGenerator.js +50 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/TypeScriptGenerator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/index.js +15 -0
- package/dist/cjs/core/schema/extensions/components/AutoDocumentation/index.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalBuilder.js +70 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalBuilder.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalElse.js +40 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalElse.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalThen.js +19 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/ConditionalThen.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/MultiConditionalBuilder.js +20 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/MultiConditionalBuilder.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/MultiConditionalThen.js +49 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/MultiConditionalThen.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/index.js +98 -0
- package/dist/cjs/core/schema/extensions/components/ConditionalValidation/index.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/FormValidator.js +85 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/FormValidator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/LiveValidator.js +133 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/LiveValidator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/StreamValidator.js +351 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/StreamValidator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/index.js +109 -0
- package/dist/cjs/core/schema/extensions/components/RealtimeValidation/index.js.map +1 -0
- package/dist/cjs/core/schema/extensions/index.js +61 -0
- package/dist/cjs/core/schema/extensions/index.js.map +1 -0
- package/dist/cjs/core/schema/extensions/mods/index.js +51 -0
- package/dist/cjs/core/schema/extensions/mods/index.js.map +1 -0
- package/dist/cjs/core/schema/extensions/mods/openapi-converter.js +227 -0
- package/dist/cjs/core/schema/extensions/mods/openapi-converter.js.map +1 -0
- package/dist/cjs/core/schema/extensions/mods/typescript-generator.js +287 -0
- package/dist/cjs/core/schema/extensions/mods/typescript-generator.js.map +1 -0
- package/dist/cjs/core/schema/extensions/mods/validation-engine.js +224 -0
- package/dist/cjs/core/schema/extensions/mods/validation-engine.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/Interface.js +277 -0
- package/dist/cjs/core/schema/mode/interfaces/Interface.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/InterfaceSchema.js +1431 -0
- package/dist/cjs/core/schema/mode/interfaces/InterfaceSchema.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/evaluator/ConditionalEvaluator.js +520 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/evaluator/ConditionalEvaluator.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalAST.js +624 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalAST.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalLexer.js +811 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalLexer.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalParser.js +599 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/parser/ConditionalParser.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/types/ConditionalTypes.js +89 -0
- package/dist/cjs/core/schema/mode/interfaces/conditional/types/ConditionalTypes.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/errors/ErrorHandler.js +356 -0
- package/dist/cjs/core/schema/mode/interfaces/errors/ErrorHandler.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/errors/types/errors.type.js +80 -0
- package/dist/cjs/core/schema/mode/interfaces/errors/types/errors.type.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/precompilation/FieldPrecompilers.js +778 -0
- package/dist/cjs/core/schema/mode/interfaces/precompilation/FieldPrecompilers.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/precompilation/SchemaPrecompiler.js +523 -0
- package/dist/cjs/core/schema/mode/interfaces/precompilation/SchemaPrecompiler.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/ConditionalTypes.js +681 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/ConditionalTypes.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/IDESupport.js +430 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/IDESupport.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/TypeInference.js +225 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/TypeInference.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/index.js +44 -0
- package/dist/cjs/core/schema/mode/interfaces/typescript/index.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/ConstraintParser.js +1134 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/ConstraintParser.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/TypeGuards.js +256 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/TypeGuards.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/TypeValidators.js +429 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/TypeValidators.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/UnionCache.js +404 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/UnionCache.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/ValidationHelpers.js +851 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/ValidationHelpers.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/passValidator.js +262 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/passValidator.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/securityValidator.js +887 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/securityValidator.js.map +1 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/urlValidation.js +191 -0
- package/dist/cjs/core/schema/mode/interfaces/validators/mods/urlValidation.js.map +1 -0
- package/dist/cjs/core/schema/optimization/ObjectValidationCache.js +462 -0
- package/dist/cjs/core/schema/optimization/ObjectValidationCache.js.map +1 -0
- package/dist/cjs/core/schema/optimization/PerformanceMonitor.js +773 -0
- package/dist/cjs/core/schema/optimization/PerformanceMonitor.js.map +1 -0
- package/dist/cjs/core/schema/optimization/SchemaCompiler.js +600 -0
- package/dist/cjs/core/schema/optimization/SchemaCompiler.js.map +1 -0
- package/dist/cjs/core/types/ValidatorTypes.js +70 -0
- package/dist/cjs/core/types/ValidatorTypes.js.map +1 -0
- package/dist/cjs/core/types/parser.type.js +12 -0
- package/dist/cjs/core/types/parser.type.js.map +1 -0
- package/dist/cjs/core/utils/Make.js +61 -0
- package/dist/cjs/core/utils/Make.js.map +1 -0
- package/dist/cjs/core/utils/Mod.js +1033 -0
- package/dist/cjs/core/utils/Mod.js.map +1 -0
- package/dist/cjs/core/utils/UrlArgs.js +102 -0
- package/dist/cjs/core/utils/UrlArgs.js.map +1 -0
- package/dist/cjs/core/utils/arrayToEnum.js +18 -0
- package/dist/cjs/core/utils/arrayToEnum.js.map +1 -0
- package/dist/cjs/core/utils/createUrlArgsEnumFArray.js +13 -0
- package/dist/cjs/core/utils/createUrlArgsEnumFArray.js.map +1 -0
- package/dist/cjs/core/utils/securityHelpers.js +215 -0
- package/dist/cjs/core/utils/securityHelpers.js.map +1 -0
- package/dist/cjs/core/utils/securityValidatorHelpers.js +65 -0
- package/dist/cjs/core/utils/securityValidatorHelpers.js.map +1 -0
- package/dist/cjs/index.js +31 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/esm/constants/SECURITY_CONSTANTS.js +47 -0
- package/dist/esm/constants/SECURITY_CONSTANTS.js.map +1 -0
- package/dist/esm/constants/VALIDATION_CONSTANTS.js +98 -0
- package/dist/esm/constants/VALIDATION_CONSTANTS.js.map +1 -0
- package/dist/esm/core/schema/extensions/SmartInference.js +197 -0
- package/dist/esm/core/schema/extensions/SmartInference.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/Docs.js +98 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/Docs.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js +190 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.js +172 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/SchemaAnalyzer.js +52 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/SchemaAnalyzer.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/TypeScriptGenerator.js +48 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/TypeScriptGenerator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/index.js +12 -0
- package/dist/esm/core/schema/extensions/components/AutoDocumentation/index.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalBuilder.js +68 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalBuilder.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalElse.js +38 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalElse.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalThen.js +17 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/ConditionalThen.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/MultiConditionalBuilder.js +18 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/MultiConditionalBuilder.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/MultiConditionalThen.js +45 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/MultiConditionalThen.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/index.js +92 -0
- package/dist/esm/core/schema/extensions/components/ConditionalValidation/index.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/FormValidator.js +83 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/FormValidator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/LiveValidator.js +131 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/LiveValidator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/StreamValidator.js +349 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/StreamValidator.js.map +1 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/index.js +103 -0
- package/dist/esm/core/schema/extensions/components/RealtimeValidation/index.js.map +1 -0
- package/dist/esm/core/schema/extensions/index.js +53 -0
- package/dist/esm/core/schema/extensions/index.js.map +1 -0
- package/dist/esm/core/schema/extensions/mods/index.js +47 -0
- package/dist/esm/core/schema/extensions/mods/index.js.map +1 -0
- package/dist/esm/core/schema/extensions/mods/openapi-converter.js +225 -0
- package/dist/esm/core/schema/extensions/mods/openapi-converter.js.map +1 -0
- package/dist/esm/core/schema/extensions/mods/typescript-generator.js +284 -0
- package/dist/esm/core/schema/extensions/mods/typescript-generator.js.map +1 -0
- package/dist/esm/core/schema/extensions/mods/validation-engine.js +222 -0
- package/dist/esm/core/schema/extensions/mods/validation-engine.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/Interface.js +269 -0
- package/dist/esm/core/schema/mode/interfaces/Interface.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/InterfaceSchema.js +1429 -0
- package/dist/esm/core/schema/mode/interfaces/InterfaceSchema.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/evaluator/ConditionalEvaluator.js +518 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/evaluator/ConditionalEvaluator.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalAST.js +620 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalAST.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalLexer.js +809 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalLexer.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalParser.js +597 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/parser/ConditionalParser.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/types/ConditionalTypes.js +89 -0
- package/dist/esm/core/schema/mode/interfaces/conditional/types/ConditionalTypes.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/errors/ErrorHandler.js +354 -0
- package/dist/esm/core/schema/mode/interfaces/errors/ErrorHandler.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/errors/types/errors.type.js +80 -0
- package/dist/esm/core/schema/mode/interfaces/errors/types/errors.type.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/precompilation/FieldPrecompilers.js +776 -0
- package/dist/esm/core/schema/mode/interfaces/precompilation/FieldPrecompilers.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/precompilation/SchemaPrecompiler.js +521 -0
- package/dist/esm/core/schema/mode/interfaces/precompilation/SchemaPrecompiler.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/ConditionalTypes.js +681 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/ConditionalTypes.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/IDESupport.js +428 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/IDESupport.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/TypeInference.js +223 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/TypeInference.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/index.js +35 -0
- package/dist/esm/core/schema/mode/interfaces/typescript/index.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/ConstraintParser.js +1132 -0
- package/dist/esm/core/schema/mode/interfaces/validators/ConstraintParser.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/TypeGuards.js +254 -0
- package/dist/esm/core/schema/mode/interfaces/validators/TypeGuards.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/TypeValidators.js +427 -0
- package/dist/esm/core/schema/mode/interfaces/validators/TypeValidators.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/UnionCache.js +400 -0
- package/dist/esm/core/schema/mode/interfaces/validators/UnionCache.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/ValidationHelpers.js +849 -0
- package/dist/esm/core/schema/mode/interfaces/validators/ValidationHelpers.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/passValidator.js +260 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/passValidator.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/securityValidator.js +881 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/securityValidator.js.map +1 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/urlValidation.js +189 -0
- package/dist/esm/core/schema/mode/interfaces/validators/mods/urlValidation.js.map +1 -0
- package/dist/esm/core/schema/optimization/ObjectValidationCache.js +460 -0
- package/dist/esm/core/schema/optimization/ObjectValidationCache.js.map +1 -0
- package/dist/esm/core/schema/optimization/PerformanceMonitor.js +771 -0
- package/dist/esm/core/schema/optimization/PerformanceMonitor.js.map +1 -0
- package/dist/esm/core/schema/optimization/SchemaCompiler.js +598 -0
- package/dist/esm/core/schema/optimization/SchemaCompiler.js.map +1 -0
- package/dist/esm/core/types/ValidatorTypes.js +65 -0
- package/dist/esm/core/types/ValidatorTypes.js.map +1 -0
- package/dist/esm/core/types/parser.type.js +12 -0
- package/dist/esm/core/types/parser.type.js.map +1 -0
- package/dist/esm/core/utils/Make.js +59 -0
- package/dist/esm/core/utils/Make.js.map +1 -0
- package/dist/esm/core/utils/Mod.js +1031 -0
- package/dist/esm/core/utils/Mod.js.map +1 -0
- package/dist/esm/core/utils/UrlArgs.js +98 -0
- package/dist/esm/core/utils/UrlArgs.js.map +1 -0
- package/dist/esm/core/utils/arrayToEnum.js +16 -0
- package/dist/esm/core/utils/arrayToEnum.js.map +1 -0
- package/dist/esm/core/utils/createUrlArgsEnumFArray.js +11 -0
- package/dist/esm/core/utils/createUrlArgsEnumFArray.js.map +1 -0
- package/dist/esm/core/utils/securityHelpers.js +207 -0
- package/dist/esm/core/utils/securityHelpers.js.map +1 -0
- package/dist/esm/core/utils/securityValidatorHelpers.js +62 -0
- package/dist/esm/core/utils/securityValidatorHelpers.js.map +1 -0
- package/dist/esm/index.js +12 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/schema.d.ts +2595 -0
- package/docs/ALL_TYPES.md +120 -0
- package/docs/API-STABILITY.md +336 -0
- package/docs/CONDITIONAL-VALIDATION.md +637 -0
- package/docs/EXAMPLES.md +876 -0
- package/docs/FIELD-TYPES.md +829 -0
- package/docs/GETTING-STARTED.md +394 -0
- package/docs/LIVE-UTILITY.md +1137 -0
- package/docs/QUICK-REFERENCE.md +346 -0
- package/docs/README.md +205 -0
- package/docs/VSCODE-EXTENSION.md +458 -0
- package/package.json +219 -0
- package/src/bench/BENCHMARK-RESULTS.md +211 -0
- package/src/bench/benchmark-results.json +148 -0
- package/src/bench/performance-comparison.ts +218 -0
- package/src/bench/precompilation-benchmark.ts +218 -0
- package/src/constants/SECURITY_CONSTANTS.ts +44 -0
- package/src/constants/VALIDATION_CONSTANTS.ts +176 -0
- package/src/core/README.md +395 -0
- package/src/core/compiler/SchemaTransformer.ts +279 -0
- package/src/core/compiler/TypeAnalyzer.ts +378 -0
- package/src/core/compiler/TypeScriptCompilerIntegration.ts +220 -0
- package/src/core/compiler/TypeToSchemaConverter.ts +288 -0
- package/src/core/index.ts +70 -0
- package/src/core/schema/extensions/AutoDocumentation.ts +572 -0
- package/src/core/schema/extensions/ConditionalValidation.ts +330 -0
- package/src/core/schema/extensions/README.md +171 -0
- package/src/core/schema/extensions/RealtimeValidation.ts +656 -0
- package/src/core/schema/extensions/SmartInference.ts +224 -0
- package/src/core/schema/extensions/components/AutoDocumentation/Docs.ts +98 -0
- package/src/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.ts +201 -0
- package/src/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.ts +176 -0
- package/src/core/schema/extensions/components/AutoDocumentation/OpenAPIGenerator.ts +175 -0
- package/src/core/schema/extensions/components/AutoDocumentation/SchemaAnalyzer.ts +49 -0
- package/src/core/schema/extensions/components/AutoDocumentation/TypeScriptGenerator.ts +54 -0
- package/src/core/schema/extensions/components/AutoDocumentation/index.ts +17 -0
- package/src/core/schema/extensions/components/ConditionalValidation/ConditionalBuilder.ts +101 -0
- package/src/core/schema/extensions/components/ConditionalValidation/ConditionalElse.ts +65 -0
- package/src/core/schema/extensions/components/ConditionalValidation/ConditionalThen.ts +33 -0
- package/src/core/schema/extensions/components/ConditionalValidation/Extend.ts +75 -0
- package/src/core/schema/extensions/components/ConditionalValidation/MultiConditionalBuilder.ts +16 -0
- package/src/core/schema/extensions/components/ConditionalValidation/MultiConditionalThen.ts +50 -0
- package/src/core/schema/extensions/components/ConditionalValidation/index.ts +104 -0
- package/src/core/schema/extensions/components/RealtimeValidation/FormValidator.ts +88 -0
- package/src/core/schema/extensions/components/RealtimeValidation/LiveValidator.ts +171 -0
- package/src/core/schema/extensions/components/RealtimeValidation/StreamValidator.ts +397 -0
- package/src/core/schema/extensions/components/RealtimeValidation/index.ts +114 -0
- package/src/core/schema/extensions/index.ts +76 -0
- package/src/core/schema/extensions/mods/index.ts +131 -0
- package/src/core/schema/extensions/mods/openapi-converter.ts +338 -0
- package/src/core/schema/extensions/mods/typescript-generator.ts +379 -0
- package/src/core/schema/extensions/mods/validation-engine.ts +295 -0
- package/src/core/schema/mode/interfaces/Interface.ts +364 -0
- package/src/core/schema/mode/interfaces/InterfaceSchema.ts +1838 -0
- package/src/core/schema/mode/interfaces/README.md +278 -0
- package/src/core/schema/mode/interfaces/conditional/evaluator/ConditionalEvaluator.ts +657 -0
- package/src/core/schema/mode/interfaces/conditional/parser/ConditionalAST.ts +826 -0
- package/src/core/schema/mode/interfaces/conditional/parser/ConditionalLexer.ts +992 -0
- package/src/core/schema/mode/interfaces/conditional/parser/ConditionalParser.ts +803 -0
- package/src/core/schema/mode/interfaces/conditional/parser/readme.md +406 -0
- package/src/core/schema/mode/interfaces/conditional/types/ConditionalTypes.ts +273 -0
- package/src/core/schema/mode/interfaces/errors/ErrorHandler.ts +624 -0
- package/src/core/schema/mode/interfaces/errors/types/errors.type.ts +102 -0
- package/src/core/schema/mode/interfaces/precompilation/FieldPrecompilers.ts +962 -0
- package/src/core/schema/mode/interfaces/precompilation/SchemaPrecompiler.ts +667 -0
- package/src/core/schema/mode/interfaces/typescript/ConditionalTypes.ts +1534 -0
- package/src/core/schema/mode/interfaces/typescript/IDESupport.ts +534 -0
- package/src/core/schema/mode/interfaces/typescript/TypeInference.ts +737 -0
- package/src/core/schema/mode/interfaces/typescript/index.ts +92 -0
- package/src/core/schema/mode/interfaces/validators/ConstraintParser.ts +1438 -0
- package/src/core/schema/mode/interfaces/validators/EnhancedErrorReporting.ts +227 -0
- package/src/core/schema/mode/interfaces/validators/TypeGuards.ts +288 -0
- package/src/core/schema/mode/interfaces/validators/TypeValidators.ts +660 -0
- package/src/core/schema/mode/interfaces/validators/UnionCache.ts +508 -0
- package/src/core/schema/mode/interfaces/validators/ValidationHelpers.ts +1257 -0
- package/src/core/schema/mode/interfaces/validators/index.ts +21 -0
- package/src/core/schema/mode/interfaces/validators/mods/passValidator.ts +424 -0
- package/src/core/schema/mode/interfaces/validators/mods/securityValidator.ts +1634 -0
- package/src/core/schema/mode/interfaces/validators/mods/urlValidation.ts +333 -0
- package/src/core/schema/optimization/ObjectValidationCache.ts +560 -0
- package/src/core/schema/optimization/PerformanceInitializer.ts +188 -0
- package/src/core/schema/optimization/PerformanceMonitor.ts +898 -0
- package/src/core/schema/optimization/SchemaCompiler.ts +730 -0
- package/src/core/testing/TestDataGenerator.ts +590 -0
- package/src/core/types/SchemaValidator.type.ts +210 -0
- package/src/core/types/ValidatorTypes.ts +93 -0
- package/src/core/types/extension.type.ts +109 -0
- package/src/core/types/objValidationCache.ts +17 -0
- package/src/core/types/parser.type.ts +15 -0
- package/src/core/types/perfoMonitor.ts +37 -0
- package/src/core/types/scompiler.ts +22 -0
- package/src/core/types/securityValidator.type.ts +10 -0
- package/src/core/types/types.ts +154 -0
- package/src/core/utils/Make.ts +97 -0
- package/src/core/utils/Mod.ts +1168 -0
- package/src/core/utils/UrlArgs.ts +124 -0
- package/src/core/utils/arrayToEnum.ts +89 -0
- package/src/core/utils/createUrlArgsEnumFArray.ts +11 -0
- package/src/core/utils/securityHelpers.ts +341 -0
- package/src/core/utils/securityValidatorHelpers.ts +76 -0
- package/src/index.ts +124 -0
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Smart Schema Inference - TypeScript type-to-schema conversion
|
|
3
|
+
*
|
|
4
|
+
* This module provides automatic schema generation from TypeScript types,
|
|
5
|
+
* making schema definition even more seamless.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { SchemaInterface } from "../mode/interfaces/Interface";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Smart inference utilities for automatic schema generation
|
|
12
|
+
*/
|
|
13
|
+
export const Smart = {
|
|
14
|
+
/**
|
|
15
|
+
* Infer schema from TypeScript interface using runtime reflection
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```typescript
|
|
19
|
+
* interface User {
|
|
20
|
+
* id: number;
|
|
21
|
+
* email: string;
|
|
22
|
+
* name?: string;
|
|
23
|
+
* }
|
|
24
|
+
*
|
|
25
|
+
* // Use with sample data that matches your interface
|
|
26
|
+
* const UserSchema = Smart.fromType<User>({
|
|
27
|
+
* id: 1,
|
|
28
|
+
* email: "user@example.com",
|
|
29
|
+
* name: "John Doe"
|
|
30
|
+
* });
|
|
31
|
+
* // Generates: Interface({ id: "positive", email: "email", name: "string?" })
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
fromType<T>(sampleData: T): SchemaInterface {
|
|
35
|
+
if (!sampleData || typeof sampleData !== "object") {
|
|
36
|
+
throw new Error(
|
|
37
|
+
"Smart.fromType() requires sample data that matches your TypeScript interface"
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return Smart.fromSample(sampleData);
|
|
42
|
+
},
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Infer schema from sample data with intelligent type detection
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```typescript
|
|
49
|
+
* const sampleUser = {
|
|
50
|
+
* id: 1,
|
|
51
|
+
* email: "user@example.com",
|
|
52
|
+
* name: "John Doe",
|
|
53
|
+
* tags: ["developer", "typescript"]
|
|
54
|
+
* };
|
|
55
|
+
*
|
|
56
|
+
* const UserSchema = Smart.fromSample(sampleUser);
|
|
57
|
+
* // Generates: Interface({ id: "positive", email: "email", name: "string", tags: "string[]" })
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
fromSample(sample: any): SchemaInterface {
|
|
61
|
+
const schema: any = {};
|
|
62
|
+
|
|
63
|
+
for (const [key, value] of Object.entries(sample)) {
|
|
64
|
+
schema[key] = Smart.inferFieldType(value);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return schema;
|
|
68
|
+
},
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Infer field type from value with smart detection
|
|
72
|
+
*/
|
|
73
|
+
inferFieldType(value: any): string {
|
|
74
|
+
if (value === null || value === undefined) {
|
|
75
|
+
return "any?";
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
if (typeof value === "string") {
|
|
79
|
+
// Smart email detection
|
|
80
|
+
if (Smart.isEmail(value)) return "email";
|
|
81
|
+
// Smart URL detection
|
|
82
|
+
if (Smart.isUrl(value)) return "url";
|
|
83
|
+
// Smart UUID detection
|
|
84
|
+
if (Smart.isUuid(value)) return "uuid";
|
|
85
|
+
// Smart phone detection
|
|
86
|
+
if (Smart.isPhone(value)) return "phone";
|
|
87
|
+
|
|
88
|
+
return "string";
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
if (typeof value === "number") {
|
|
92
|
+
// Smart positive number detection
|
|
93
|
+
if (value > 0 && Number.isInteger(value)) return "positive";
|
|
94
|
+
if (Number.isInteger(value)) return "int";
|
|
95
|
+
return "number";
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
if (typeof value === "boolean") {
|
|
99
|
+
return "boolean";
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
if (value instanceof Date) {
|
|
103
|
+
return "date";
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
if (Array.isArray(value)) {
|
|
107
|
+
if (value.length === 0) return "any[]";
|
|
108
|
+
|
|
109
|
+
// Detect array element type from first element
|
|
110
|
+
const elementType = Smart.inferFieldType(value[0]);
|
|
111
|
+
const baseType = elementType.replace("?", ""); // Remove optional marker
|
|
112
|
+
return `${baseType}[]`;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (typeof value === "object") {
|
|
116
|
+
// Nested object - recursively infer
|
|
117
|
+
const nestedSchema: any = {};
|
|
118
|
+
for (const [nestedKey, nestedValue] of Object.entries(value)) {
|
|
119
|
+
nestedSchema[nestedKey] = Smart.inferFieldType(nestedValue);
|
|
120
|
+
}
|
|
121
|
+
return nestedSchema;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
return "any";
|
|
125
|
+
},
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Smart format detection utilities
|
|
129
|
+
*/
|
|
130
|
+
isEmail(str: string): boolean {
|
|
131
|
+
return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(str);
|
|
132
|
+
},
|
|
133
|
+
|
|
134
|
+
isUrl(str: string): boolean {
|
|
135
|
+
try {
|
|
136
|
+
new URL(str);
|
|
137
|
+
return true;
|
|
138
|
+
} catch {
|
|
139
|
+
return false;
|
|
140
|
+
}
|
|
141
|
+
},
|
|
142
|
+
|
|
143
|
+
isUuid(str: string): boolean {
|
|
144
|
+
return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(
|
|
145
|
+
str
|
|
146
|
+
);
|
|
147
|
+
},
|
|
148
|
+
|
|
149
|
+
isPhone(str: string): boolean {
|
|
150
|
+
return /^\+?[1-9]\d{1,14}$/.test(str.replace(/[\s\-\(\)]/g, ""));
|
|
151
|
+
},
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Generate schema from JSON Schema (migration helper)
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```typescript
|
|
158
|
+
* const jsonSchema = {
|
|
159
|
+
* type: "object",
|
|
160
|
+
* properties: {
|
|
161
|
+
* id: { type: "number" },
|
|
162
|
+
* email: { type: "string", format: "email" }
|
|
163
|
+
* }
|
|
164
|
+
* };
|
|
165
|
+
*
|
|
166
|
+
* const schema = Smart.fromJsonSchema(jsonSchema);
|
|
167
|
+
* ```
|
|
168
|
+
*/
|
|
169
|
+
fromJsonSchema(jsonSchema: any): SchemaInterface {
|
|
170
|
+
if (jsonSchema.type === "object" && jsonSchema.properties) {
|
|
171
|
+
const schema: any = {};
|
|
172
|
+
|
|
173
|
+
for (const [key, prop] of Object.entries(jsonSchema.properties as any)) {
|
|
174
|
+
schema[key] = Smart.convertJsonSchemaProperty(prop);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
return schema;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
throw new Error("Unsupported JSON Schema format");
|
|
181
|
+
},
|
|
182
|
+
|
|
183
|
+
convertJsonSchemaProperty(prop: any): string {
|
|
184
|
+
const isOptional = !prop.required;
|
|
185
|
+
const suffix = isOptional ? "?" : "";
|
|
186
|
+
|
|
187
|
+
switch (prop.type) {
|
|
188
|
+
case "string":
|
|
189
|
+
if (prop.format === "email") return `email${suffix}`;
|
|
190
|
+
if (prop.format === "uri") return `url${suffix}`;
|
|
191
|
+
if (prop.format === "uuid") return `uuid${suffix}`;
|
|
192
|
+
if (prop.minLength && prop.maxLength) {
|
|
193
|
+
return `string(${prop.minLength},${prop.maxLength})${suffix}`;
|
|
194
|
+
}
|
|
195
|
+
return `string${suffix}`;
|
|
196
|
+
|
|
197
|
+
case "number":
|
|
198
|
+
case "integer":
|
|
199
|
+
if (prop.minimum && prop.maximum) {
|
|
200
|
+
return `number(${prop.minimum},${prop.maximum})${suffix}`;
|
|
201
|
+
}
|
|
202
|
+
if (prop.minimum > 0) return `positive${suffix}`;
|
|
203
|
+
return prop.type === "integer" ? `int${suffix}` : `number${suffix}`;
|
|
204
|
+
|
|
205
|
+
case "boolean":
|
|
206
|
+
return `boolean${suffix}`;
|
|
207
|
+
|
|
208
|
+
case "array":
|
|
209
|
+
const itemType = Smart.convertJsonSchemaProperty(
|
|
210
|
+
prop.items || { type: "any" }
|
|
211
|
+
);
|
|
212
|
+
const baseType = itemType.replace("?", "");
|
|
213
|
+
return `${baseType}[]${suffix}`;
|
|
214
|
+
|
|
215
|
+
default:
|
|
216
|
+
return `any${suffix}`;
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
};
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Export for easy access
|
|
223
|
+
*/
|
|
224
|
+
export default Smart;
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { Documentation, DocumentationOptions, InteractiveDocumentation, InteractiveOptions } from "../../../../types/extension.type";
|
|
2
|
+
import { SchemaInterface } from "../../../../types/SchemaValidator.type";
|
|
3
|
+
import { OpenAPIConverter, OpenAPISpecification, OpenAPISpecOptions } from "../../mods";
|
|
4
|
+
import { TSGenerator , TypeScriptOptions as TSOptions} from "../../mods/typescript-generator";
|
|
5
|
+
import { DocumentationGenerator, InteractiveDocumentationGenerator } from ".";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Auto documentation utilities
|
|
9
|
+
*/
|
|
10
|
+
export const Docs = {
|
|
11
|
+
/**
|
|
12
|
+
* Generate comprehensive documentation from schema
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* const UserSchema = Interface({
|
|
17
|
+
* id: "uuid",
|
|
18
|
+
* email: "email",
|
|
19
|
+
* name: "string(2,50)",
|
|
20
|
+
* age: "int(18,120)?",
|
|
21
|
+
* role: Make.union("user", "admin", "moderator")
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* const documentation = Docs.generate(UserSchema, {
|
|
25
|
+
* title: "User API",
|
|
26
|
+
* description: "User management endpoints",
|
|
27
|
+
* examples: true,
|
|
28
|
+
* interactive: true
|
|
29
|
+
* });
|
|
30
|
+
*
|
|
31
|
+
* console.log(documentation.markdown);
|
|
32
|
+
* console.log(documentation.html);
|
|
33
|
+
* console.log(documentation.openapi);
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
generate(schema: SchemaInterface, options: DocumentationOptions = {}): Documentation {
|
|
37
|
+
return new DocumentationGenerator(schema, options).generate();
|
|
38
|
+
},
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Generate OpenAPI specification from schema
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* const openApiSpec = Docs.openapi(UserSchema, {
|
|
46
|
+
* title: "User API",
|
|
47
|
+
* version: "1.0.0",
|
|
48
|
+
* servers: ["https://api.example.com"]
|
|
49
|
+
* });
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
openapi(schema: SchemaInterface, options: OpenAPISpecOptions): OpenAPISpecification {
|
|
53
|
+
return OpenAPIConverter.generateOpenAPISpec(schema, options);
|
|
54
|
+
},
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Generate TypeScript type definitions
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```typescript
|
|
61
|
+
* const typeDefinitions = Docs.typescript(UserSchema, {
|
|
62
|
+
* exportName: "User",
|
|
63
|
+
* namespace: "API"
|
|
64
|
+
* });
|
|
65
|
+
*
|
|
66
|
+
* // Generates:
|
|
67
|
+
* // export interface User {
|
|
68
|
+
* // id: string;
|
|
69
|
+
* // email: string;
|
|
70
|
+
* // name: string;
|
|
71
|
+
* // age?: number;
|
|
72
|
+
* // role: "user" | "admin" | "moderator";
|
|
73
|
+
* // }
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
typescript(schema: SchemaInterface, options: TSOptions = {}): string {
|
|
77
|
+
return TSGenerator.generateInterface(schema, options);
|
|
78
|
+
},
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Generate interactive documentation with live examples
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* const interactiveDocs = Docs.interactive(UserSchema, {
|
|
86
|
+
* title: "User Schema Playground",
|
|
87
|
+
* theme: "dark",
|
|
88
|
+
* showExamples: true,
|
|
89
|
+
* allowTesting: true
|
|
90
|
+
* });
|
|
91
|
+
*
|
|
92
|
+
* document.body.innerHTML = interactiveDocs.html;
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
interactive(schema: SchemaInterface, options: InteractiveOptions = {}): InteractiveDocumentation {
|
|
96
|
+
return new InteractiveDocumentationGenerator(schema, options).generate();
|
|
97
|
+
}
|
|
98
|
+
};
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import { Documentation, DocumentationOptions, FieldInfo, OpenAPISpec, SchemaAnalysis } from "../../../../types/extension.type";
|
|
2
|
+
import { SchemaInterface } from "../../../../types/SchemaValidator.type";
|
|
3
|
+
import { SchemaAnalyzer } from "./SchemaAnalyzer";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Main documentation generator
|
|
7
|
+
*/
|
|
8
|
+
export class DocumentationGenerator {
|
|
9
|
+
constructor(
|
|
10
|
+
private schema: SchemaInterface,
|
|
11
|
+
private options: DocumentationOptions
|
|
12
|
+
) {}
|
|
13
|
+
|
|
14
|
+
generate(): Documentation {
|
|
15
|
+
const analyzer = new SchemaAnalyzer(this.schema);
|
|
16
|
+
const analysis = analyzer.analyze();
|
|
17
|
+
|
|
18
|
+
return {
|
|
19
|
+
markdown: this.generateMarkdown(analysis),
|
|
20
|
+
html: this.generateHTML(analysis),
|
|
21
|
+
openapi: this.generateOpenAPI(analysis),
|
|
22
|
+
json: this.generateJSON(analysis),
|
|
23
|
+
examples: this.generateExamples(analysis)
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
private generateMarkdown(analysis: SchemaAnalysis): string {
|
|
28
|
+
const { title = "Schema Documentation", description = "" } = this.options;
|
|
29
|
+
|
|
30
|
+
let markdown = `# ${title}\n\n`;
|
|
31
|
+
if (description) {
|
|
32
|
+
markdown += `${description}\n\n`;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
markdown += "## Schema Structure\n\n";
|
|
36
|
+
markdown += this.generateFieldTable(analysis.fields);
|
|
37
|
+
|
|
38
|
+
if (this.options.examples) {
|
|
39
|
+
markdown += "\n## Examples\n\n";
|
|
40
|
+
markdown += this.generateExampleMarkdown(analysis);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
return markdown;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
private generateHTML(analysis: SchemaAnalysis): string {
|
|
47
|
+
const { title = "Schema Documentation" } = this.options;
|
|
48
|
+
|
|
49
|
+
return `
|
|
50
|
+
<!DOCTYPE html>
|
|
51
|
+
<html>
|
|
52
|
+
<head>
|
|
53
|
+
<title>${title}</title>
|
|
54
|
+
<style>
|
|
55
|
+
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; }
|
|
56
|
+
.field { margin: 1rem 0; padding: 1rem; border: 1px solid #e1e5e9; border-radius: 6px; }
|
|
57
|
+
.field-name { font-weight: bold; color: #0366d6; }
|
|
58
|
+
.field-type { color: #6f42c1; font-family: monospace; }
|
|
59
|
+
.field-description { color: #586069; margin-top: 0.5rem; }
|
|
60
|
+
.example { background: #f6f8fa; padding: 1rem; border-radius: 6px; margin: 1rem 0; }
|
|
61
|
+
pre { background: #f6f8fa; padding: 1rem; border-radius: 6px; overflow-x: auto; }
|
|
62
|
+
</style>
|
|
63
|
+
</head>
|
|
64
|
+
<body>
|
|
65
|
+
<h1>${title}</h1>
|
|
66
|
+
${this.generateFieldHTML(analysis.fields)}
|
|
67
|
+
${this.options.examples ? this.generateExampleHTML(analysis) : ''}
|
|
68
|
+
</body>
|
|
69
|
+
</html>`;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
private generateOpenAPI(analysis: SchemaAnalysis): OpenAPISpec {
|
|
73
|
+
return {
|
|
74
|
+
openapi: "3.0.0",
|
|
75
|
+
info: {
|
|
76
|
+
title: this.options.title || "API Documentation",
|
|
77
|
+
version: "1.0.0"
|
|
78
|
+
},
|
|
79
|
+
components: {
|
|
80
|
+
schemas: {
|
|
81
|
+
[this.options.title || "Schema"]: this.convertToOpenAPISchema(analysis)
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
private generateJSON(analysis: SchemaAnalysis): any {
|
|
88
|
+
return {
|
|
89
|
+
schema: this.schema,
|
|
90
|
+
analysis,
|
|
91
|
+
metadata: {
|
|
92
|
+
generatedAt: new Date().toISOString(),
|
|
93
|
+
version: "1.0.0"
|
|
94
|
+
}
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
private generateExamples(analysis: SchemaAnalysis): any[] {
|
|
99
|
+
return [
|
|
100
|
+
this.generateValidExample(analysis),
|
|
101
|
+
this.generateInvalidExample(analysis)
|
|
102
|
+
];
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
private generateFieldTable(fields: FieldInfo[]): string {
|
|
106
|
+
let table = "| Field | Type | Required | Description |\n";
|
|
107
|
+
table += "|-------|------|----------|-------------|\n";
|
|
108
|
+
|
|
109
|
+
fields.forEach(field => {
|
|
110
|
+
table += `| ${field.name} | \`${field.type}\` | ${field.required ? 'Yes' : 'No'} | ${field.description || ''} |\n`;
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
return table;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
private generateFieldHTML(fields: FieldInfo[]): string {
|
|
117
|
+
return fields.map(field => `
|
|
118
|
+
<div class="field">
|
|
119
|
+
<div class="field-name">${field.name}</div>
|
|
120
|
+
<div class="field-type">${field.type}</div>
|
|
121
|
+
<div class="field-description">${field.description || ''}</div>
|
|
122
|
+
</div>
|
|
123
|
+
`).join('');
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
private generateExampleMarkdown(analysis: SchemaAnalysis): string {
|
|
127
|
+
const example = this.generateValidExample(analysis);
|
|
128
|
+
return `\`\`\`json\n${JSON.stringify(example, null, 2)}\n\`\`\``;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
private generateExampleHTML(analysis: SchemaAnalysis): string {
|
|
132
|
+
const example = this.generateValidExample(analysis);
|
|
133
|
+
return `<div class="example"><pre>${JSON.stringify(example, null, 2)}</pre></div>`;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
private generateValidExample(analysis: SchemaAnalysis): any {
|
|
137
|
+
const example: any = {};
|
|
138
|
+
|
|
139
|
+
analysis.fields.forEach(field => {
|
|
140
|
+
if (field.required || Math.random() > 0.3) { // Include some optional fields
|
|
141
|
+
example[field.name] = this.generateExampleValue(field.type);
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
return example;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
private generateInvalidExample(analysis: SchemaAnalysis): any {
|
|
149
|
+
const example = this.generateValidExample(analysis);
|
|
150
|
+
// Introduce some invalid data
|
|
151
|
+
if (example.email) example.email = "invalid-email";
|
|
152
|
+
if (example.age) example.age = -5;
|
|
153
|
+
return example;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
private generateExampleValue(type: string): any {
|
|
157
|
+
if (type === "email") return "user@example.com";
|
|
158
|
+
if (type === "uuid") return "550e8400-e29b-41d4-a716-446655440000";
|
|
159
|
+
if (type === "url") return "https://example.com";
|
|
160
|
+
if (type.startsWith("string")) return "Example string";
|
|
161
|
+
if (type.includes("number") || type === "positive" || type === "int") return 42;
|
|
162
|
+
if (type === "boolean") return true;
|
|
163
|
+
if (type === "date") return new Date().toISOString();
|
|
164
|
+
if (type.includes("[]")) return ["item1", "item2"];
|
|
165
|
+
return "example";
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
private convertToOpenAPISchema(analysis: SchemaAnalysis): any {
|
|
169
|
+
const properties: any = {};
|
|
170
|
+
const required: string[] = [];
|
|
171
|
+
|
|
172
|
+
analysis.fields.forEach(field => {
|
|
173
|
+
properties[field.name] = this.convertFieldToOpenAPI(field);
|
|
174
|
+
if (field.required) {
|
|
175
|
+
required.push(field.name);
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
return {
|
|
180
|
+
type: "object",
|
|
181
|
+
properties,
|
|
182
|
+
required
|
|
183
|
+
};
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
private convertFieldToOpenAPI(field: FieldInfo): any {
|
|
187
|
+
const type = field.type;
|
|
188
|
+
|
|
189
|
+
if (type === "email") return { type: "string", format: "email" };
|
|
190
|
+
if (type === "uuid") return { type: "string", format: "uuid" };
|
|
191
|
+
if (type === "url") return { type: "string", format: "uri" };
|
|
192
|
+
if (type.startsWith("string")) return { type: "string" };
|
|
193
|
+
if (type.includes("number") || type === "positive" || type === "int") return { type: "number" };
|
|
194
|
+
if (type === "boolean") return { type: "boolean" };
|
|
195
|
+
if (type === "date") return { type: "string", format: "date-time" };
|
|
196
|
+
if (type.includes("[]")) return { type: "array", items: { type: "string" } };
|
|
197
|
+
|
|
198
|
+
return { type: "string" };
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
|
package/src/core/schema/extensions/components/AutoDocumentation/InteractiveDocumentationGenerator.ts
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import { InteractiveDocumentation, InteractiveOptions } from "../../../../types/extension.type";
|
|
2
|
+
import { SchemaInterface } from "../../../../types/SchemaValidator.type";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Interactive documentation generator
|
|
6
|
+
*/
|
|
7
|
+
export class InteractiveDocumentationGenerator {
|
|
8
|
+
constructor(
|
|
9
|
+
private schema: SchemaInterface,
|
|
10
|
+
private options: InteractiveOptions
|
|
11
|
+
) {}
|
|
12
|
+
|
|
13
|
+
generate(): InteractiveDocumentation {
|
|
14
|
+
return {
|
|
15
|
+
html: this.generateInteractiveHTML(),
|
|
16
|
+
css: this.generateCSS(),
|
|
17
|
+
javascript: this.generateJavaScript()
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
private generateInteractiveHTML(): string {
|
|
22
|
+
return `
|
|
23
|
+
<div id="schema-playground">
|
|
24
|
+
<h1>${this.options.title || 'Schema Playground'}</h1>
|
|
25
|
+
<div class="playground-container">
|
|
26
|
+
<div class="schema-panel">
|
|
27
|
+
<h2>Schema</h2>
|
|
28
|
+
<pre id="schema-display"></pre>
|
|
29
|
+
</div>
|
|
30
|
+
<div class="input-panel">
|
|
31
|
+
<h2>Test Data</h2>
|
|
32
|
+
<textarea id="test-input" placeholder="Enter JSON data to validate..."></textarea>
|
|
33
|
+
<button id="validate-btn">Validate</button>
|
|
34
|
+
</div>
|
|
35
|
+
<div class="result-panel">
|
|
36
|
+
<h2>Result</h2>
|
|
37
|
+
<div id="validation-result"></div>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
</div>`;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
private generateCSS(): string {
|
|
44
|
+
return `
|
|
45
|
+
.playground-container { display: grid; grid-template-columns: 1fr 1fr 1fr; gap: 1rem; }
|
|
46
|
+
.schema-panel, .input-panel, .result-panel { border: 1px solid #e1e5e9; border-radius: 6px; padding: 1rem; }
|
|
47
|
+
#test-input { width: 100%; height: 200px; font-family: monospace; }
|
|
48
|
+
#validate-btn { background: #0366d6; color: white; border: none; padding: 0.5rem 1rem; border-radius: 4px; cursor: pointer; }
|
|
49
|
+
.valid { color: #28a745; }
|
|
50
|
+
.invalid { color: #dc3545; }`;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
private generateJavaScript(): string {
|
|
54
|
+
const schemaStr = JSON.stringify(this.schema, null, 2);
|
|
55
|
+
return `
|
|
56
|
+
document.getElementById('schema-display').textContent = ${schemaStr};
|
|
57
|
+
|
|
58
|
+
// Real validation function
|
|
59
|
+
function validateData(schema, data) {
|
|
60
|
+
const errors = [];
|
|
61
|
+
|
|
62
|
+
for (const [fieldName, fieldType] of Object.entries(schema)) {
|
|
63
|
+
const value = data[fieldName];
|
|
64
|
+
const fieldErrors = validateField(fieldType, value, fieldName);
|
|
65
|
+
if (fieldErrors.length > 0) {
|
|
66
|
+
errors.push(...fieldErrors);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return errors;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function validateField(fieldType, value, fieldName) {
|
|
74
|
+
const errors = [];
|
|
75
|
+
|
|
76
|
+
if (typeof fieldType === 'string') {
|
|
77
|
+
const isOptional = fieldType.includes('?');
|
|
78
|
+
const cleanType = fieldType.replace('?', '');
|
|
79
|
+
|
|
80
|
+
// Handle null/undefined for optional fields
|
|
81
|
+
if (isOptional && (value === null || value === undefined)) {
|
|
82
|
+
return errors;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Required field cannot be null/undefined
|
|
86
|
+
if (!isOptional && (value === null || value === undefined)) {
|
|
87
|
+
errors.push(fieldName + ': Field is required');
|
|
88
|
+
return errors;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// Type-specific validation
|
|
92
|
+
if (cleanType === 'email') {
|
|
93
|
+
if (typeof value !== 'string' || !/^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/.test(value)) {
|
|
94
|
+
errors.push(fieldName + ': Invalid email format');
|
|
95
|
+
}
|
|
96
|
+
} else if (cleanType === 'url') {
|
|
97
|
+
if (typeof value !== 'string') {
|
|
98
|
+
errors.push(fieldName + ': URL must be a string');
|
|
99
|
+
} else {
|
|
100
|
+
try {
|
|
101
|
+
new URL(value);
|
|
102
|
+
} catch {
|
|
103
|
+
errors.push(fieldName + ': Invalid URL format');
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
} else if (cleanType === 'uuid') {
|
|
107
|
+
if (typeof value !== 'string' || !/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value)) {
|
|
108
|
+
errors.push(fieldName + ': Invalid UUID format');
|
|
109
|
+
}
|
|
110
|
+
} else if (cleanType === 'number') {
|
|
111
|
+
if (typeof value !== 'number' || isNaN(value)) {
|
|
112
|
+
errors.push(fieldName + ': Must be a valid number');
|
|
113
|
+
}
|
|
114
|
+
} else if (cleanType === 'positive') {
|
|
115
|
+
if (typeof value !== 'number' || isNaN(value) || value <= 0) {
|
|
116
|
+
errors.push(fieldName + ': Must be a positive number');
|
|
117
|
+
}
|
|
118
|
+
} else if (cleanType === 'int') {
|
|
119
|
+
if (typeof value !== 'number' || isNaN(value) || !Number.isInteger(value)) {
|
|
120
|
+
errors.push(fieldName + ': Must be an integer');
|
|
121
|
+
}
|
|
122
|
+
} else if (cleanType === 'boolean') {
|
|
123
|
+
if (typeof value !== 'boolean') {
|
|
124
|
+
errors.push(fieldName + ': Must be a boolean');
|
|
125
|
+
}
|
|
126
|
+
} else if (cleanType === 'string') {
|
|
127
|
+
if (typeof value !== 'string') {
|
|
128
|
+
errors.push(fieldName + ': Must be a string');
|
|
129
|
+
}
|
|
130
|
+
} else if (cleanType.startsWith('string(')) {
|
|
131
|
+
if (typeof value !== 'string') {
|
|
132
|
+
errors.push(fieldName + ': Must be a string');
|
|
133
|
+
} else {
|
|
134
|
+
const match = cleanType.match(/string\\((\\d+)?,?(\\d+)?\\)/);
|
|
135
|
+
if (match) {
|
|
136
|
+
const minLength = match[1] ? parseInt(match[1]) : 0;
|
|
137
|
+
const maxLength = match[2] ? parseInt(match[2]) : Infinity;
|
|
138
|
+
if (value.length < minLength) {
|
|
139
|
+
errors.push(fieldName + ': String too short (min ' + minLength + ')');
|
|
140
|
+
}
|
|
141
|
+
if (value.length > maxLength) {
|
|
142
|
+
errors.push(fieldName + ': String too long (max ' + maxLength + ')');
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
} else if (cleanType.includes('[]')) {
|
|
147
|
+
if (!Array.isArray(value)) {
|
|
148
|
+
errors.push(fieldName + ': Must be an array');
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
return errors;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
document.getElementById('validate-btn').addEventListener('click', function() {
|
|
157
|
+
const input = document.getElementById('test-input').value;
|
|
158
|
+
const result = document.getElementById('validation-result');
|
|
159
|
+
|
|
160
|
+
try {
|
|
161
|
+
const data = JSON.parse(input);
|
|
162
|
+
const schema = ${schemaStr};
|
|
163
|
+
const validationErrors = validateData(schema, data);
|
|
164
|
+
|
|
165
|
+
if (validationErrors.length === 0) {
|
|
166
|
+
result.innerHTML = '<div class="valid">✓ Valid data</div>';
|
|
167
|
+
} else {
|
|
168
|
+
result.innerHTML = '<div class="invalid">✗ Validation errors:<br>' +
|
|
169
|
+
validationErrors.map(err => '• ' + err).join('<br>') + '</div>';
|
|
170
|
+
}
|
|
171
|
+
} catch (e) {
|
|
172
|
+
result.innerHTML = '<div class="invalid">✗ Invalid JSON: ' + e.message + '</div>';
|
|
173
|
+
}
|
|
174
|
+
});`;
|
|
175
|
+
}
|
|
176
|
+
}
|