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,49 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const SECURITY_CONSTANTS = {
|
|
4
|
+
MAX_JSON_SIZE: 10 * 1024 * 1024, // 10MB
|
|
5
|
+
MAX_TEXT_LENGTH: 1024 * 1024, // 1MB
|
|
6
|
+
MAX_VALIDATION_TIME: 5000, // 5 seconds
|
|
7
|
+
DANGEROUS_PROPERTIES: new Set([
|
|
8
|
+
"__proto__",
|
|
9
|
+
"constructor",
|
|
10
|
+
"prototype",
|
|
11
|
+
"valueOf",
|
|
12
|
+
"toString",
|
|
13
|
+
"hasOwnProperty",
|
|
14
|
+
"isPrototypeOf",
|
|
15
|
+
"propertyIsEnumerable",
|
|
16
|
+
"__defineGetter__",
|
|
17
|
+
"__defineSetter__",
|
|
18
|
+
"__lookupGetter__",
|
|
19
|
+
"__lookupSetter__",
|
|
20
|
+
]),
|
|
21
|
+
XSS_PATTERNS: [
|
|
22
|
+
/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,
|
|
23
|
+
/javascript:\s*[^;]*/gi,
|
|
24
|
+
/on\w+\s*=\s*["'][^"']*["']/gi,
|
|
25
|
+
/<iframe\b[^>]*>/gi,
|
|
26
|
+
/<object\b[^>]*>/gi,
|
|
27
|
+
/<embed\b[^>]*>/gi,
|
|
28
|
+
/<form\b[^>]*>/gi,
|
|
29
|
+
/data:\s*text\/html/gi,
|
|
30
|
+
/vbscript:/gi,
|
|
31
|
+
/<meta\b[^>]*http-equiv/gi,
|
|
32
|
+
],
|
|
33
|
+
SQL_PATTERNS: [
|
|
34
|
+
/(\b(SELECT|INSERT|UPDATE|DELETE|DROP|CREATE|ALTER|EXEC|EXECUTE|UNION|TRUNCATE|GRANT|REVOKE)\b)/gi,
|
|
35
|
+
/(union\s+select|or\s+1\s*=\s*1|and\s+1\s*=\s*1)/gi,
|
|
36
|
+
/('|--|\*|;|\|\|)/g,
|
|
37
|
+
/(0x[0-9a-fA-F]+|char\(|ascii\(|substring\()/gi,
|
|
38
|
+
/(sleep\(|benchmark\(|waitfor\s+delay)/gi,
|
|
39
|
+
],
|
|
40
|
+
LDAP_PATTERNS: [/[()&|!]/g, /\*(?!\w)/g, /[\x00-\x1f\x7f]/g],
|
|
41
|
+
COMMAND_INJECTION_PATTERNS: [
|
|
42
|
+
/[;&|`$(){}[\]\\]/g,
|
|
43
|
+
/(curl|wget|nc|netcat|telnet|ssh|ftp|tftp)/gi,
|
|
44
|
+
/(\.\.|\/etc\/|\/bin\/|\/usr\/|\/var\/)/gi,
|
|
45
|
+
],
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
exports.SECURITY_CONSTANTS = SECURITY_CONSTANTS;
|
|
49
|
+
//# sourceMappingURL=SECURITY_CONSTANTS.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SECURITY_CONSTANTS.js","sources":["../../../src/constants/SECURITY_CONSTANTS.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAa,MAAA,kBAAkB,GAAG;AAChC,IAAA,aAAa,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;AAC/B,IAAA,eAAe,EAAE,IAAI,GAAG,IAAI;IAC5B,mBAAmB,EAAE,IAAI;IACzB,oBAAoB,EAAE,IAAI,GAAG,CAAC;QAC5B,WAAW;QACX,aAAa;QACb,WAAW;QACX,SAAS;QACT,UAAU;QACV,gBAAgB;QAChB,eAAe;QACf,sBAAsB;QACtB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;KACnB,CAAC;AACF,IAAA,YAAY,EAAE;QACZ,qDAAqD;QACrD,uBAAuB;QACvB,8BAA8B;QAC9B,mBAAmB;QACnB,mBAAmB;QACnB,kBAAkB;QAClB,iBAAiB;QACjB,sBAAsB;QACtB,aAAa;QACb,0BAA0B;AAC3B,KAAA;AACD,IAAA,YAAY,EAAE;QACZ,kGAAkG;QAClG,mDAAmD;QACnD,mBAAmB;QACnB,+CAA+C;QAC/C,yCAAyC;AAC1C,KAAA;AACD,IAAA,aAAa,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC;AAC5D,IAAA,0BAA0B,EAAE;QAC1B,mBAAmB;QACnB,6CAA6C;QAC7C,0CAA0C;AAC3C,KAAA;;;;;"}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* VALIDATION CONSTANTS
|
|
5
|
+
*
|
|
6
|
+
* CENTRALIZED VALIDATION SYSTEM - SUCCESSFULLY IMPLEMENTED
|
|
7
|
+
*
|
|
8
|
+
* This module provides centralized configuration for all validation limits
|
|
9
|
+
* across the ReliantType system. All validation components now use these
|
|
10
|
+
* constants, making the system easy to maintain and configure.
|
|
11
|
+
*
|
|
12
|
+
* ACHIEVEMENT: Replaced scattered hardcoded limits with centralized control
|
|
13
|
+
* MAINTENANCE: Change values here to update limits throughout the entire system
|
|
14
|
+
* CURRENT STATUS: System supports up to 100-level deep validation
|
|
15
|
+
*/
|
|
16
|
+
const VALIDATION_CONSTANTS = {
|
|
17
|
+
/**
|
|
18
|
+
* Maximum object nesting depth for validation
|
|
19
|
+
*
|
|
20
|
+
* SUCCESSFULLY APPLIED TO:
|
|
21
|
+
* - Schema compilation depth (SchemaPrecompiler.ts)
|
|
22
|
+
* - Security validation depth (securityValidator.ts)
|
|
23
|
+
* - JSON validation depth (securityHelpers.ts)
|
|
24
|
+
* - Object validation depth (validateObjectDeep)
|
|
25
|
+
* - AST traversal depth (ConditionalAST.ts)
|
|
26
|
+
*
|
|
27
|
+
* USAGE: Change this value to adjust depth limits across the entire system
|
|
28
|
+
* 100 for most use cases, increase for extreme nesting needs
|
|
29
|
+
* PERFORMANCE: Very high values may impact performance and memory usage
|
|
30
|
+
*/
|
|
31
|
+
MAX_OBJECT_DEPTH: 500,
|
|
32
|
+
/**
|
|
33
|
+
* Maximum compilation depth for schema precompiler
|
|
34
|
+
*
|
|
35
|
+
* AUTOMATICALLY MATCHES: MAX_OBJECT_DEPTH for consistency
|
|
36
|
+
* PURPOSE: Prevents infinite recursion during schema compilation
|
|
37
|
+
* IMPLEMENTATION: Used by SchemaPrecompiler.ts for depth checking
|
|
38
|
+
*/
|
|
39
|
+
MAX_COMPILATION_DEPTH: 500,
|
|
40
|
+
/**
|
|
41
|
+
* Maximum AST traversal depth for conditional parsing
|
|
42
|
+
* Higher limit for complex conditional expressions
|
|
43
|
+
*/
|
|
44
|
+
MAX_AST_TRAVERSAL_DEPTH: 1000,
|
|
45
|
+
/**
|
|
46
|
+
* Performance and safety limits
|
|
47
|
+
*/
|
|
48
|
+
PERFORMANCE: {
|
|
49
|
+
MAX_CACHE_SIZE: 5000,
|
|
50
|
+
CACHE_TTL: 300000, // 5 minutes
|
|
51
|
+
HOT_PATH_THRESHOLD: 10,
|
|
52
|
+
MAX_VALIDATION_TIME: 5000, // 5 seconds
|
|
53
|
+
},
|
|
54
|
+
/**
|
|
55
|
+
* Object structure limits
|
|
56
|
+
*/
|
|
57
|
+
OBJECT_LIMITS: {
|
|
58
|
+
MAX_KEYS: 1000,
|
|
59
|
+
MAX_PROPERTY_NAME_LENGTH: 100,
|
|
60
|
+
MAX_STRING_LENGTH: 10000,
|
|
61
|
+
MAX_ARRAY_LENGTH: 1000,
|
|
62
|
+
},
|
|
63
|
+
/**
|
|
64
|
+
* Security validation limits
|
|
65
|
+
*/
|
|
66
|
+
SECURITY: {
|
|
67
|
+
MAX_JSON_SIZE: 10 * 1024 * 1024, // 10MB
|
|
68
|
+
MAX_TEXT_LENGTH: 1024 * 1024, // 1MB
|
|
69
|
+
PREVENT_CIRCULAR: true,
|
|
70
|
+
PREVENT_PROTOTYPE_POLLUTION: true,
|
|
71
|
+
},
|
|
72
|
+
/**
|
|
73
|
+
* Conditional validation limits
|
|
74
|
+
*/
|
|
75
|
+
CONDITIONAL: {
|
|
76
|
+
MAX_EXPRESSION_DEPTH: 50,
|
|
77
|
+
MAX_PROPERTY_PATH_LENGTH: 200,
|
|
78
|
+
MAX_CONDITION_COMPLEXITY: 100,
|
|
79
|
+
},
|
|
80
|
+
/**
|
|
81
|
+
* Development and debugging
|
|
82
|
+
*/
|
|
83
|
+
DEBUG: {
|
|
84
|
+
ENABLE_DEPTH_WARNINGS: true,
|
|
85
|
+
LOG_PERFORMANCE_METRICS: false,
|
|
86
|
+
TRACK_VALIDATION_PATHS: false,
|
|
87
|
+
},
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* Export individual constants for convenience
|
|
91
|
+
*
|
|
92
|
+
* CENTRALIZED ACCESS: Import these constants throughout the system
|
|
93
|
+
* CONSISTENCY: All components use the same validation limits
|
|
94
|
+
*/
|
|
95
|
+
const MAX_OBJECT_DEPTH = VALIDATION_CONSTANTS.MAX_OBJECT_DEPTH;
|
|
96
|
+
const MAX_COMPILATION_DEPTH = VALIDATION_CONSTANTS.MAX_COMPILATION_DEPTH;
|
|
97
|
+
const MAX_AST_TRAVERSAL_DEPTH = VALIDATION_CONSTANTS.MAX_AST_TRAVERSAL_DEPTH;
|
|
98
|
+
|
|
99
|
+
exports.MAX_AST_TRAVERSAL_DEPTH = MAX_AST_TRAVERSAL_DEPTH;
|
|
100
|
+
exports.MAX_COMPILATION_DEPTH = MAX_COMPILATION_DEPTH;
|
|
101
|
+
exports.MAX_OBJECT_DEPTH = MAX_OBJECT_DEPTH;
|
|
102
|
+
exports.VALIDATION_CONSTANTS = VALIDATION_CONSTANTS;
|
|
103
|
+
//# sourceMappingURL=VALIDATION_CONSTANTS.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"VALIDATION_CONSTANTS.js","sources":["../../../src/constants/VALIDATION_CONSTANTS.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;;;;;;;;AAYG;AAEU,MAAA,oBAAoB,GAAG;AAClC;;;;;;;;;;;;;AAaG;AACH,IAAA,gBAAgB,EAAE,GAAG;AAErB;;;;;;AAMG;AACH,IAAA,qBAAqB,EAAE,GAAG;AAE1B;;;AAGG;AACH,IAAA,uBAAuB,EAAE,IAAI;AAE7B;;AAEG;AACH,IAAA,WAAW,EAAE;AACX,QAAA,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,MAAM;AACjB,QAAA,kBAAkB,EAAE,EAAE;QACtB,mBAAmB,EAAE,IAAI;AAC1B,KAAA;AAED;;AAEG;AACH,IAAA,aAAa,EAAE;AACb,QAAA,QAAQ,EAAE,IAAI;AACd,QAAA,wBAAwB,EAAE,GAAG;AAC7B,QAAA,iBAAiB,EAAE,KAAK;AACxB,QAAA,gBAAgB,EAAE,IAAI;AACvB,KAAA;AAED;;AAEG;AACH,IAAA,QAAQ,EAAE;AACR,QAAA,aAAa,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;AAC/B,QAAA,eAAe,EAAE,IAAI,GAAG,IAAI;AAC5B,QAAA,gBAAgB,EAAE,IAAI;AACtB,QAAA,2BAA2B,EAAE,IAAI;AAClC,KAAA;AAED;;AAEG;AACH,IAAA,WAAW,EAAE;AACX,QAAA,oBAAoB,EAAE,EAAE;AACxB,QAAA,wBAAwB,EAAE,GAAG;AAC7B,QAAA,wBAAwB,EAAE,GAAG;AAC9B,KAAA;AAED;;AAEG;AACH,IAAA,KAAK,EAAE;AACL,QAAA,qBAAqB,EAAE,IAAI;AAC3B,QAAA,uBAAuB,EAAE,KAAK;AAC9B,QAAA,sBAAsB,EAAE,KAAK;AAC9B,KAAA;EACQ;AAyEX;;;;;AAKG;AACU,MAAA,gBAAgB,GAAG,oBAAoB,CAAC,iBAAiB;AACzD,MAAA,qBAAqB,GAAG,oBAAoB,CAAC,sBAAsB;AACnE,MAAA,uBAAuB,GAClC,oBAAoB,CAAC;;;;;;;"}
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Smart Schema Inference - TypeScript type-to-schema conversion
|
|
5
|
+
*
|
|
6
|
+
* This module provides automatic schema generation from TypeScript types,
|
|
7
|
+
* making schema definition even more seamless.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* Smart inference utilities for automatic schema generation
|
|
11
|
+
*/
|
|
12
|
+
const Smart = {
|
|
13
|
+
/**
|
|
14
|
+
* Infer schema from TypeScript interface using runtime reflection
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* interface User {
|
|
19
|
+
* id: number;
|
|
20
|
+
* email: string;
|
|
21
|
+
* name?: string;
|
|
22
|
+
* }
|
|
23
|
+
*
|
|
24
|
+
* // Use with sample data that matches your interface
|
|
25
|
+
* const UserSchema = Smart.fromType<User>({
|
|
26
|
+
* id: 1,
|
|
27
|
+
* email: "user@example.com",
|
|
28
|
+
* name: "John Doe"
|
|
29
|
+
* });
|
|
30
|
+
* // Generates: Interface({ id: "positive", email: "email", name: "string?" })
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
fromType(sampleData) {
|
|
34
|
+
if (!sampleData || typeof sampleData !== "object") {
|
|
35
|
+
throw new Error("Smart.fromType() requires sample data that matches your TypeScript interface");
|
|
36
|
+
}
|
|
37
|
+
return Smart.fromSample(sampleData);
|
|
38
|
+
},
|
|
39
|
+
/**
|
|
40
|
+
* Infer schema from sample data with intelligent type detection
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const sampleUser = {
|
|
45
|
+
* id: 1,
|
|
46
|
+
* email: "user@example.com",
|
|
47
|
+
* name: "John Doe",
|
|
48
|
+
* tags: ["developer", "typescript"]
|
|
49
|
+
* };
|
|
50
|
+
*
|
|
51
|
+
* const UserSchema = Smart.fromSample(sampleUser);
|
|
52
|
+
* // Generates: Interface({ id: "positive", email: "email", name: "string", tags: "string[]" })
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
fromSample(sample) {
|
|
56
|
+
const schema = {};
|
|
57
|
+
for (const [key, value] of Object.entries(sample)) {
|
|
58
|
+
schema[key] = Smart.inferFieldType(value);
|
|
59
|
+
}
|
|
60
|
+
return schema;
|
|
61
|
+
},
|
|
62
|
+
/**
|
|
63
|
+
* Infer field type from value with smart detection
|
|
64
|
+
*/
|
|
65
|
+
inferFieldType(value) {
|
|
66
|
+
if (value === null || value === undefined) {
|
|
67
|
+
return "any?";
|
|
68
|
+
}
|
|
69
|
+
if (typeof value === "string") {
|
|
70
|
+
// Smart email detection
|
|
71
|
+
if (Smart.isEmail(value))
|
|
72
|
+
return "email";
|
|
73
|
+
// Smart URL detection
|
|
74
|
+
if (Smart.isUrl(value))
|
|
75
|
+
return "url";
|
|
76
|
+
// Smart UUID detection
|
|
77
|
+
if (Smart.isUuid(value))
|
|
78
|
+
return "uuid";
|
|
79
|
+
// Smart phone detection
|
|
80
|
+
if (Smart.isPhone(value))
|
|
81
|
+
return "phone";
|
|
82
|
+
return "string";
|
|
83
|
+
}
|
|
84
|
+
if (typeof value === "number") {
|
|
85
|
+
// Smart positive number detection
|
|
86
|
+
if (value > 0 && Number.isInteger(value))
|
|
87
|
+
return "positive";
|
|
88
|
+
if (Number.isInteger(value))
|
|
89
|
+
return "int";
|
|
90
|
+
return "number";
|
|
91
|
+
}
|
|
92
|
+
if (typeof value === "boolean") {
|
|
93
|
+
return "boolean";
|
|
94
|
+
}
|
|
95
|
+
if (value instanceof Date) {
|
|
96
|
+
return "date";
|
|
97
|
+
}
|
|
98
|
+
if (Array.isArray(value)) {
|
|
99
|
+
if (value.length === 0)
|
|
100
|
+
return "any[]";
|
|
101
|
+
// Detect array element type from first element
|
|
102
|
+
const elementType = Smart.inferFieldType(value[0]);
|
|
103
|
+
const baseType = elementType.replace("?", ""); // Remove optional marker
|
|
104
|
+
return `${baseType}[]`;
|
|
105
|
+
}
|
|
106
|
+
if (typeof value === "object") {
|
|
107
|
+
// Nested object - recursively infer
|
|
108
|
+
const nestedSchema = {};
|
|
109
|
+
for (const [nestedKey, nestedValue] of Object.entries(value)) {
|
|
110
|
+
nestedSchema[nestedKey] = Smart.inferFieldType(nestedValue);
|
|
111
|
+
}
|
|
112
|
+
return nestedSchema;
|
|
113
|
+
}
|
|
114
|
+
return "any";
|
|
115
|
+
},
|
|
116
|
+
/**
|
|
117
|
+
* Smart format detection utilities
|
|
118
|
+
*/
|
|
119
|
+
isEmail(str) {
|
|
120
|
+
return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(str);
|
|
121
|
+
},
|
|
122
|
+
isUrl(str) {
|
|
123
|
+
try {
|
|
124
|
+
new URL(str);
|
|
125
|
+
return true;
|
|
126
|
+
}
|
|
127
|
+
catch {
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
isUuid(str) {
|
|
132
|
+
return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(str);
|
|
133
|
+
},
|
|
134
|
+
isPhone(str) {
|
|
135
|
+
return /^\+?[1-9]\d{1,14}$/.test(str.replace(/[\s\-\(\)]/g, ""));
|
|
136
|
+
},
|
|
137
|
+
/**
|
|
138
|
+
* Generate schema from JSON Schema (migration helper)
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```typescript
|
|
142
|
+
* const jsonSchema = {
|
|
143
|
+
* type: "object",
|
|
144
|
+
* properties: {
|
|
145
|
+
* id: { type: "number" },
|
|
146
|
+
* email: { type: "string", format: "email" }
|
|
147
|
+
* }
|
|
148
|
+
* };
|
|
149
|
+
*
|
|
150
|
+
* const schema = Smart.fromJsonSchema(jsonSchema);
|
|
151
|
+
* ```
|
|
152
|
+
*/
|
|
153
|
+
fromJsonSchema(jsonSchema) {
|
|
154
|
+
if (jsonSchema.type === "object" && jsonSchema.properties) {
|
|
155
|
+
const schema = {};
|
|
156
|
+
for (const [key, prop] of Object.entries(jsonSchema.properties)) {
|
|
157
|
+
schema[key] = Smart.convertJsonSchemaProperty(prop);
|
|
158
|
+
}
|
|
159
|
+
return schema;
|
|
160
|
+
}
|
|
161
|
+
throw new Error("Unsupported JSON Schema format");
|
|
162
|
+
},
|
|
163
|
+
convertJsonSchemaProperty(prop) {
|
|
164
|
+
const isOptional = !prop.required;
|
|
165
|
+
const suffix = isOptional ? "?" : "";
|
|
166
|
+
switch (prop.type) {
|
|
167
|
+
case "string":
|
|
168
|
+
if (prop.format === "email")
|
|
169
|
+
return `email${suffix}`;
|
|
170
|
+
if (prop.format === "uri")
|
|
171
|
+
return `url${suffix}`;
|
|
172
|
+
if (prop.format === "uuid")
|
|
173
|
+
return `uuid${suffix}`;
|
|
174
|
+
if (prop.minLength && prop.maxLength) {
|
|
175
|
+
return `string(${prop.minLength},${prop.maxLength})${suffix}`;
|
|
176
|
+
}
|
|
177
|
+
return `string${suffix}`;
|
|
178
|
+
case "number":
|
|
179
|
+
case "integer":
|
|
180
|
+
if (prop.minimum && prop.maximum) {
|
|
181
|
+
return `number(${prop.minimum},${prop.maximum})${suffix}`;
|
|
182
|
+
}
|
|
183
|
+
if (prop.minimum > 0)
|
|
184
|
+
return `positive${suffix}`;
|
|
185
|
+
return prop.type === "integer" ? `int${suffix}` : `number${suffix}`;
|
|
186
|
+
case "boolean":
|
|
187
|
+
return `boolean${suffix}`;
|
|
188
|
+
case "array":
|
|
189
|
+
const itemType = Smart.convertJsonSchemaProperty(prop.items || { type: "any" });
|
|
190
|
+
const baseType = itemType.replace("?", "");
|
|
191
|
+
return `${baseType}[]${suffix}`;
|
|
192
|
+
default:
|
|
193
|
+
return `any${suffix}`;
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
};
|
|
197
|
+
|
|
198
|
+
exports.Smart = Smart;
|
|
199
|
+
exports.default = Smart;
|
|
200
|
+
//# sourceMappingURL=SmartInference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SmartInference.js","sources":["../../../../../src/core/schema/extensions/SmartInference.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;;;;AAKG;AAIH;;AAEG;AACU,MAAA,KAAK,GAAG;AACnB;;;;;;;;;;;;;;;;;;;AAmBG;AACH,IAAA,QAAQ,CAAI,UAAa,EAAA;QACvB,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AACjD,YAAA,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;SACH;AAED,QAAA,OAAO,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;KACrC;AAED;;;;;;;;;;;;;;;AAeG;AACH,IAAA,UAAU,CAAC,MAAW,EAAA;QACpB,MAAM,MAAM,GAAQ,EAAE,CAAC;AAEvB,QAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACjD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SAC3C;AAED,QAAA,OAAO,MAAM,CAAC;KACf;AAED;;AAEG;AACH,IAAA,cAAc,CAAC,KAAU,EAAA;QACvB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;AACzC,YAAA,OAAO,MAAM,CAAC;SACf;AAED,QAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;;AAE7B,YAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,OAAO,CAAC;;AAEzC,YAAA,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,KAAK,CAAC;;AAErC,YAAA,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,MAAM,CAAC;;AAEvC,YAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,OAAO,CAAC;AAEzC,YAAA,OAAO,QAAQ,CAAC;SACjB;AAED,QAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;;YAE7B,IAAI,KAAK,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,UAAU,CAAC;AAC5D,YAAA,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,KAAK,CAAC;AAC1C,YAAA,OAAO,QAAQ,CAAC;SACjB;AAED,QAAA,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;AAC9B,YAAA,OAAO,SAAS,CAAC;SAClB;AAED,QAAA,IAAI,KAAK,YAAY,IAAI,EAAE;AACzB,YAAA,OAAO,MAAM,CAAC;SACf;AAED,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACxB,YAAA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;AAAE,gBAAA,OAAO,OAAO,CAAC;;YAGvC,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACnD,YAAA,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC9C,OAAO,CAAA,EAAG,QAAQ,CAAA,EAAA,CAAI,CAAC;SACxB;AAED,QAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;;YAE7B,MAAM,YAAY,GAAQ,EAAE,CAAC;AAC7B,YAAA,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC5D,YAAY,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;aAC7D;AACD,YAAA,OAAO,YAAY,CAAC;SACrB;AAED,QAAA,OAAO,KAAK,CAAC;KACd;AAED;;AAEG;AACH,IAAA,OAAO,CAAC,GAAW,EAAA;AACjB,QAAA,OAAO,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAC/C;AAED,IAAA,KAAK,CAAC,GAAW,EAAA;AACf,QAAA,IAAI;AACF,YAAA,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;AACb,YAAA,OAAO,IAAI,CAAC;SACb;AAAC,QAAA,MAAM;AACN,YAAA,OAAO,KAAK,CAAC;SACd;KACF;AAED,IAAA,MAAM,CAAC,GAAW,EAAA;AAChB,QAAA,OAAO,iEAAiE,CAAC,IAAI,CAC3E,GAAG,CACJ,CAAC;KACH;AAED,IAAA,OAAO,CAAC,GAAW,EAAA;AACjB,QAAA,OAAO,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;KAClE;AAED;;;;;;;;;;;;;;;AAeG;AACH,IAAA,cAAc,CAAC,UAAe,EAAA;QAC5B,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,EAAE;YACzD,MAAM,MAAM,GAAQ,EAAE,CAAC;AAEvB,YAAA,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAiB,CAAC,EAAE;gBACtE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;aACrD;AAED,YAAA,OAAO,MAAM,CAAC;SACf;AAED,QAAA,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;KACnD;AAED,IAAA,yBAAyB,CAAC,IAAS,EAAA;AACjC,QAAA,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;QAClC,MAAM,MAAM,GAAG,UAAU,GAAG,GAAG,GAAG,EAAE,CAAC;AAErC,QAAA,QAAQ,IAAI,CAAC,IAAI;AACf,YAAA,KAAK,QAAQ;AACX,gBAAA,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO;oBAAE,OAAO,CAAA,KAAA,EAAQ,MAAM,CAAA,CAAE,CAAC;AACrD,gBAAA,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK;oBAAE,OAAO,CAAA,GAAA,EAAM,MAAM,CAAA,CAAE,CAAC;AACjD,gBAAA,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM;oBAAE,OAAO,CAAA,IAAA,EAAO,MAAM,CAAA,CAAE,CAAC;gBACnD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE;oBACpC,OAAO,CAAA,OAAA,EAAU,IAAI,CAAC,SAAS,CAAA,CAAA,EAAI,IAAI,CAAC,SAAS,CAAA,CAAA,EAAI,MAAM,CAAA,CAAE,CAAC;iBAC/D;gBACD,OAAO,CAAA,MAAA,EAAS,MAAM,CAAA,CAAE,CAAC;AAE3B,YAAA,KAAK,QAAQ,CAAC;AACd,YAAA,KAAK,SAAS;gBACZ,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChC,OAAO,CAAA,OAAA,EAAU,IAAI,CAAC,OAAO,CAAA,CAAA,EAAI,IAAI,CAAC,OAAO,CAAA,CAAA,EAAI,MAAM,CAAA,CAAE,CAAC;iBAC3D;AACD,gBAAA,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;oBAAE,OAAO,CAAA,QAAA,EAAW,MAAM,CAAA,CAAE,CAAC;AACjD,gBAAA,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,GAAG,CAAM,GAAA,EAAA,MAAM,EAAE,GAAG,CAAS,MAAA,EAAA,MAAM,EAAE,CAAC;AAEtE,YAAA,KAAK,SAAS;gBACZ,OAAO,CAAA,OAAA,EAAU,MAAM,CAAA,CAAE,CAAC;AAE5B,YAAA,KAAK,OAAO;AACV,gBAAA,MAAM,QAAQ,GAAG,KAAK,CAAC,yBAAyB,CAC9C,IAAI,CAAC,KAAK,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAC9B,CAAC;gBACF,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC3C,gBAAA,OAAO,CAAG,EAAA,QAAQ,CAAK,EAAA,EAAA,MAAM,EAAE,CAAC;AAElC,YAAA;gBACE,OAAO,CAAA,GAAA,EAAM,MAAM,CAAA,CAAE,CAAC;SACzB;KACF;;;;;;"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
require('../../mods/index.js');
|
|
4
|
+
var typescriptGenerator = require('../../mods/typescript-generator.js');
|
|
5
|
+
var DocumentationGenerator = require('./DocumentationGenerator.js');
|
|
6
|
+
var InteractiveDocumentationGenerator = require('./InteractiveDocumentationGenerator.js');
|
|
7
|
+
var openapiConverter = require('../../mods/openapi-converter.js');
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Auto documentation utilities
|
|
11
|
+
*/
|
|
12
|
+
const Docs = {
|
|
13
|
+
/**
|
|
14
|
+
* Generate comprehensive documentation from schema
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* const UserSchema = Interface({
|
|
19
|
+
* id: "uuid",
|
|
20
|
+
* email: "email",
|
|
21
|
+
* name: "string(2,50)",
|
|
22
|
+
* age: "int(18,120)?",
|
|
23
|
+
* role: Make.union("user", "admin", "moderator")
|
|
24
|
+
* });
|
|
25
|
+
*
|
|
26
|
+
* const documentation = Docs.generate(UserSchema, {
|
|
27
|
+
* title: "User API",
|
|
28
|
+
* description: "User management endpoints",
|
|
29
|
+
* examples: true,
|
|
30
|
+
* interactive: true
|
|
31
|
+
* });
|
|
32
|
+
*
|
|
33
|
+
* console.log(documentation.markdown);
|
|
34
|
+
* console.log(documentation.html);
|
|
35
|
+
* console.log(documentation.openapi);
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
generate(schema, options = {}) {
|
|
39
|
+
return new DocumentationGenerator.DocumentationGenerator(schema, options).generate();
|
|
40
|
+
},
|
|
41
|
+
/**
|
|
42
|
+
* Generate OpenAPI specification from schema
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```typescript
|
|
46
|
+
* const openApiSpec = Docs.openapi(UserSchema, {
|
|
47
|
+
* title: "User API",
|
|
48
|
+
* version: "1.0.0",
|
|
49
|
+
* servers: ["https://api.example.com"]
|
|
50
|
+
* });
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
openapi(schema, options) {
|
|
54
|
+
return openapiConverter.OpenAPIConverter.generateOpenAPISpec(schema, options);
|
|
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, options = {}) {
|
|
77
|
+
return typescriptGenerator.TypeScriptGenerator.generateInterface(schema, options);
|
|
78
|
+
},
|
|
79
|
+
/**
|
|
80
|
+
* Generate interactive documentation with live examples
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```typescript
|
|
84
|
+
* const interactiveDocs = Docs.interactive(UserSchema, {
|
|
85
|
+
* title: "User Schema Playground",
|
|
86
|
+
* theme: "dark",
|
|
87
|
+
* showExamples: true,
|
|
88
|
+
* allowTesting: true
|
|
89
|
+
* });
|
|
90
|
+
*
|
|
91
|
+
* document.body.innerHTML = interactiveDocs.html;
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
interactive(schema, options = {}) {
|
|
95
|
+
return new InteractiveDocumentationGenerator.InteractiveDocumentationGenerator(schema, options).generate();
|
|
96
|
+
}
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
exports.Docs = Docs;
|
|
100
|
+
//# sourceMappingURL=Docs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Docs.js","sources":["../../../../../../../src/core/schema/extensions/components/AutoDocumentation/Docs.ts"],"sourcesContent":[null],"names":["DocumentationGenerator","OpenAPIConverter","TSGenerator","InteractiveDocumentationGenerator"],"mappings":";;;;;;;;AAMA;;AAEG;AACU,MAAA,IAAI,GAAG;AAChB;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACH,IAAA,QAAQ,CAAC,MAAuB,EAAE,OAAA,GAAgC,EAAE,EAAA;QAChE,OAAO,IAAIA,6CAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;KACjE;AAED;;;;;;;;;;;AAWG;IACH,OAAO,CAAC,MAAuB,EAAE,OAA2B,EAAA;QACxD,OAAOC,iCAAgB,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChE;AAED;;;;;;;;;;;;;;;;;;;AAmBG;AACH,IAAA,UAAU,CAAC,MAAuB,EAAE,OAAA,GAAqB,EAAE,EAAA;QACvD,OAAOC,uCAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACzD;AAED;;;;;;;;;;;;;;AAcG;AACH,IAAA,WAAW,CAAC,MAAuB,EAAE,OAAA,GAA8B,EAAE,EAAA;QACjE,OAAO,IAAIC,mEAAiC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;KAC5E;;;;;"}
|
package/dist/cjs/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var SchemaAnalyzer = require('./SchemaAnalyzer.js');
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Main documentation generator
|
|
7
|
+
*/
|
|
8
|
+
class DocumentationGenerator {
|
|
9
|
+
constructor(schema, options) {
|
|
10
|
+
this.schema = schema;
|
|
11
|
+
this.options = options;
|
|
12
|
+
}
|
|
13
|
+
generate() {
|
|
14
|
+
const analyzer = new SchemaAnalyzer.SchemaAnalyzer(this.schema);
|
|
15
|
+
const analysis = analyzer.analyze();
|
|
16
|
+
return {
|
|
17
|
+
markdown: this.generateMarkdown(analysis),
|
|
18
|
+
html: this.generateHTML(analysis),
|
|
19
|
+
openapi: this.generateOpenAPI(analysis),
|
|
20
|
+
json: this.generateJSON(analysis),
|
|
21
|
+
examples: this.generateExamples(analysis)
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
generateMarkdown(analysis) {
|
|
25
|
+
const { title = "Schema Documentation", description = "" } = this.options;
|
|
26
|
+
let markdown = `# ${title}\n\n`;
|
|
27
|
+
if (description) {
|
|
28
|
+
markdown += `${description}\n\n`;
|
|
29
|
+
}
|
|
30
|
+
markdown += "## Schema Structure\n\n";
|
|
31
|
+
markdown += this.generateFieldTable(analysis.fields);
|
|
32
|
+
if (this.options.examples) {
|
|
33
|
+
markdown += "\n## Examples\n\n";
|
|
34
|
+
markdown += this.generateExampleMarkdown(analysis);
|
|
35
|
+
}
|
|
36
|
+
return markdown;
|
|
37
|
+
}
|
|
38
|
+
generateHTML(analysis) {
|
|
39
|
+
const { title = "Schema Documentation" } = this.options;
|
|
40
|
+
return `
|
|
41
|
+
<!DOCTYPE html>
|
|
42
|
+
<html>
|
|
43
|
+
<head>
|
|
44
|
+
<title>${title}</title>
|
|
45
|
+
<style>
|
|
46
|
+
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; }
|
|
47
|
+
.field { margin: 1rem 0; padding: 1rem; border: 1px solid #e1e5e9; border-radius: 6px; }
|
|
48
|
+
.field-name { font-weight: bold; color: #0366d6; }
|
|
49
|
+
.field-type { color: #6f42c1; font-family: monospace; }
|
|
50
|
+
.field-description { color: #586069; margin-top: 0.5rem; }
|
|
51
|
+
.example { background: #f6f8fa; padding: 1rem; border-radius: 6px; margin: 1rem 0; }
|
|
52
|
+
pre { background: #f6f8fa; padding: 1rem; border-radius: 6px; overflow-x: auto; }
|
|
53
|
+
</style>
|
|
54
|
+
</head>
|
|
55
|
+
<body>
|
|
56
|
+
<h1>${title}</h1>
|
|
57
|
+
${this.generateFieldHTML(analysis.fields)}
|
|
58
|
+
${this.options.examples ? this.generateExampleHTML(analysis) : ''}
|
|
59
|
+
</body>
|
|
60
|
+
</html>`;
|
|
61
|
+
}
|
|
62
|
+
generateOpenAPI(analysis) {
|
|
63
|
+
return {
|
|
64
|
+
openapi: "3.0.0",
|
|
65
|
+
info: {
|
|
66
|
+
title: this.options.title || "API Documentation",
|
|
67
|
+
version: "1.0.0"
|
|
68
|
+
},
|
|
69
|
+
components: {
|
|
70
|
+
schemas: {
|
|
71
|
+
[this.options.title || "Schema"]: this.convertToOpenAPISchema(analysis)
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
generateJSON(analysis) {
|
|
77
|
+
return {
|
|
78
|
+
schema: this.schema,
|
|
79
|
+
analysis,
|
|
80
|
+
metadata: {
|
|
81
|
+
generatedAt: new Date().toISOString(),
|
|
82
|
+
version: "1.0.0"
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
generateExamples(analysis) {
|
|
87
|
+
return [
|
|
88
|
+
this.generateValidExample(analysis),
|
|
89
|
+
this.generateInvalidExample(analysis)
|
|
90
|
+
];
|
|
91
|
+
}
|
|
92
|
+
generateFieldTable(fields) {
|
|
93
|
+
let table = "| Field | Type | Required | Description |\n";
|
|
94
|
+
table += "|-------|------|----------|-------------|\n";
|
|
95
|
+
fields.forEach(field => {
|
|
96
|
+
table += `| ${field.name} | \`${field.type}\` | ${field.required ? 'Yes' : 'No'} | ${field.description || ''} |\n`;
|
|
97
|
+
});
|
|
98
|
+
return table;
|
|
99
|
+
}
|
|
100
|
+
generateFieldHTML(fields) {
|
|
101
|
+
return fields.map(field => `
|
|
102
|
+
<div class="field">
|
|
103
|
+
<div class="field-name">${field.name}</div>
|
|
104
|
+
<div class="field-type">${field.type}</div>
|
|
105
|
+
<div class="field-description">${field.description || ''}</div>
|
|
106
|
+
</div>
|
|
107
|
+
`).join('');
|
|
108
|
+
}
|
|
109
|
+
generateExampleMarkdown(analysis) {
|
|
110
|
+
const example = this.generateValidExample(analysis);
|
|
111
|
+
return `\`\`\`json\n${JSON.stringify(example, null, 2)}\n\`\`\``;
|
|
112
|
+
}
|
|
113
|
+
generateExampleHTML(analysis) {
|
|
114
|
+
const example = this.generateValidExample(analysis);
|
|
115
|
+
return `<div class="example"><pre>${JSON.stringify(example, null, 2)}</pre></div>`;
|
|
116
|
+
}
|
|
117
|
+
generateValidExample(analysis) {
|
|
118
|
+
const example = {};
|
|
119
|
+
analysis.fields.forEach(field => {
|
|
120
|
+
if (field.required || Math.random() > 0.3) { // Include some optional fields
|
|
121
|
+
example[field.name] = this.generateExampleValue(field.type);
|
|
122
|
+
}
|
|
123
|
+
});
|
|
124
|
+
return example;
|
|
125
|
+
}
|
|
126
|
+
generateInvalidExample(analysis) {
|
|
127
|
+
const example = this.generateValidExample(analysis);
|
|
128
|
+
// Introduce some invalid data
|
|
129
|
+
if (example.email)
|
|
130
|
+
example.email = "invalid-email";
|
|
131
|
+
if (example.age)
|
|
132
|
+
example.age = -5;
|
|
133
|
+
return example;
|
|
134
|
+
}
|
|
135
|
+
generateExampleValue(type) {
|
|
136
|
+
if (type === "email")
|
|
137
|
+
return "user@example.com";
|
|
138
|
+
if (type === "uuid")
|
|
139
|
+
return "550e8400-e29b-41d4-a716-446655440000";
|
|
140
|
+
if (type === "url")
|
|
141
|
+
return "https://example.com";
|
|
142
|
+
if (type.startsWith("string"))
|
|
143
|
+
return "Example string";
|
|
144
|
+
if (type.includes("number") || type === "positive" || type === "int")
|
|
145
|
+
return 42;
|
|
146
|
+
if (type === "boolean")
|
|
147
|
+
return true;
|
|
148
|
+
if (type === "date")
|
|
149
|
+
return new Date().toISOString();
|
|
150
|
+
if (type.includes("[]"))
|
|
151
|
+
return ["item1", "item2"];
|
|
152
|
+
return "example";
|
|
153
|
+
}
|
|
154
|
+
convertToOpenAPISchema(analysis) {
|
|
155
|
+
const properties = {};
|
|
156
|
+
const required = [];
|
|
157
|
+
analysis.fields.forEach(field => {
|
|
158
|
+
properties[field.name] = this.convertFieldToOpenAPI(field);
|
|
159
|
+
if (field.required) {
|
|
160
|
+
required.push(field.name);
|
|
161
|
+
}
|
|
162
|
+
});
|
|
163
|
+
return {
|
|
164
|
+
type: "object",
|
|
165
|
+
properties,
|
|
166
|
+
required
|
|
167
|
+
};
|
|
168
|
+
}
|
|
169
|
+
convertFieldToOpenAPI(field) {
|
|
170
|
+
const type = field.type;
|
|
171
|
+
if (type === "email")
|
|
172
|
+
return { type: "string", format: "email" };
|
|
173
|
+
if (type === "uuid")
|
|
174
|
+
return { type: "string", format: "uuid" };
|
|
175
|
+
if (type === "url")
|
|
176
|
+
return { type: "string", format: "uri" };
|
|
177
|
+
if (type.startsWith("string"))
|
|
178
|
+
return { type: "string" };
|
|
179
|
+
if (type.includes("number") || type === "positive" || type === "int")
|
|
180
|
+
return { type: "number" };
|
|
181
|
+
if (type === "boolean")
|
|
182
|
+
return { type: "boolean" };
|
|
183
|
+
if (type === "date")
|
|
184
|
+
return { type: "string", format: "date-time" };
|
|
185
|
+
if (type.includes("[]"))
|
|
186
|
+
return { type: "array", items: { type: "string" } };
|
|
187
|
+
return { type: "string" };
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
exports.DocumentationGenerator = DocumentationGenerator;
|
|
192
|
+
//# sourceMappingURL=DocumentationGenerator.js.map
|
package/dist/cjs/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DocumentationGenerator.js","sources":["../../../../../../../src/core/schema/extensions/components/AutoDocumentation/DocumentationGenerator.ts"],"sourcesContent":[null],"names":["SchemaAnalyzer"],"mappings":";;;;AAIA;;AAEG;MACU,sBAAsB,CAAA;IAC/B,WACY,CAAA,MAAuB,EACvB,OAA6B,EAAA;QAD7B,IAAM,CAAA,MAAA,GAAN,MAAM,CAAiB;QACvB,IAAO,CAAA,OAAA,GAAP,OAAO,CAAsB;KACrC;IAEJ,QAAQ,GAAA;QACJ,MAAM,QAAQ,GAAG,IAAIA,6BAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjD,QAAA,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEpC,OAAO;AACH,YAAA,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;AACzC,YAAA,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;AACjC,YAAA,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;AACvC,YAAA,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;AACjC,YAAA,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;SAC5C,CAAC;KACL;AAEO,IAAA,gBAAgB,CAAC,QAAwB,EAAA;AAC7C,QAAA,MAAM,EAAE,KAAK,GAAG,sBAAsB,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;AAE1E,QAAA,IAAI,QAAQ,GAAG,CAAK,EAAA,EAAA,KAAK,MAAM,CAAC;QAChC,IAAI,WAAW,EAAE;AACb,YAAA,QAAQ,IAAI,CAAA,EAAG,WAAW,CAAA,IAAA,CAAM,CAAC;SACpC;QAED,QAAQ,IAAI,yBAAyB,CAAC;QACtC,QAAQ,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAErD,QAAA,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACvB,QAAQ,IAAI,mBAAmB,CAAC;AAChC,YAAA,QAAQ,IAAI,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;SACtD;AAED,QAAA,OAAO,QAAQ,CAAC;KACnB;AAEO,IAAA,YAAY,CAAC,QAAwB,EAAA;QACzC,MAAM,EAAE,KAAK,GAAG,sBAAsB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAExD,OAAO,CAAA;;;;aAIF,KAAK,CAAA;;;;;;;;;;;;UAYR,KAAK,CAAA;AACT,IAAA,EAAA,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AACvC,IAAA,EAAA,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAA;;QAE7D,CAAC;KACJ;AAEO,IAAA,eAAe,CAAC,QAAwB,EAAA;QAC5C,OAAO;AACH,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,IAAI,EAAE;AACF,gBAAA,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,mBAAmB;AAChD,gBAAA,OAAO,EAAE,OAAO;AACnB,aAAA;AACD,YAAA,UAAU,EAAE;AACR,gBAAA,OAAO,EAAE;AACL,oBAAA,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;AAC1E,iBAAA;AACJ,aAAA;SACJ,CAAC;KACL;AAEO,IAAA,YAAY,CAAC,QAAwB,EAAA;QACzC,OAAO;YACH,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ;AACR,YAAA,QAAQ,EAAE;AACN,gBAAA,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;AACrC,gBAAA,OAAO,EAAE,OAAO;AACnB,aAAA;SACJ,CAAC;KACL;AAEO,IAAA,gBAAgB,CAAC,QAAwB,EAAA;QAC7C,OAAO;AACH,YAAA,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;AACnC,YAAA,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;SACxC,CAAC;KACL;AAEO,IAAA,kBAAkB,CAAC,MAAmB,EAAA;QAC1C,IAAI,KAAK,GAAG,6CAA6C,CAAC;QAC1D,KAAK,IAAI,6CAA6C,CAAC;AAEvD,QAAA,MAAM,CAAC,OAAO,CAAC,KAAK,IAAG;AACnB,YAAA,KAAK,IAAI,CAAA,EAAA,EAAK,KAAK,CAAC,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAC,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAA,GAAA,EAAM,KAAK,CAAC,WAAW,IAAI,EAAE,CAAA,IAAA,CAAM,CAAC;AACvH,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,KAAK,CAAC;KAChB;AAEO,IAAA,iBAAiB,CAAC,MAAmB,EAAA;AACzC,QAAA,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;;AAEO,wCAAA,EAAA,KAAK,CAAC,IAAI,CAAA;AACV,wCAAA,EAAA,KAAK,CAAC,IAAI,CAAA;iDACH,KAAK,CAAC,WAAW,IAAI,EAAE,CAAA;;AAE/D,QAAA,CAAA,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACf;AAEO,IAAA,uBAAuB,CAAC,QAAwB,EAAA;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AACpD,QAAA,OAAO,CAAe,YAAA,EAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA,QAAA,CAAU,CAAC;KACpE;AAEO,IAAA,mBAAmB,CAAC,QAAwB,EAAA;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AACpD,QAAA,OAAO,CAA6B,0BAAA,EAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA,YAAA,CAAc,CAAC;KACtF;AAEO,IAAA,oBAAoB,CAAC,QAAwB,EAAA;QACjD,MAAM,OAAO,GAAQ,EAAE,CAAC;AAExB,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAG;AAC5B,YAAA,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE;AACvC,gBAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC/D;AACL,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,OAAO,CAAC;KAClB;AAEO,IAAA,sBAAsB,CAAC,QAAwB,EAAA;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;;QAEpD,IAAI,OAAO,CAAC,KAAK;AAAE,YAAA,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;QACnD,IAAI,OAAO,CAAC,GAAG;AAAE,YAAA,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AAClC,QAAA,OAAO,OAAO,CAAC;KAClB;AAEO,IAAA,oBAAoB,CAAC,IAAY,EAAA;QACrC,IAAI,IAAI,KAAK,OAAO;AAAE,YAAA,OAAO,kBAAkB,CAAC;QAChD,IAAI,IAAI,KAAK,MAAM;AAAE,YAAA,OAAO,sCAAsC,CAAC;QACnE,IAAI,IAAI,KAAK,KAAK;AAAE,YAAA,OAAO,qBAAqB,CAAC;AACjD,QAAA,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;AAAE,YAAA,OAAO,gBAAgB,CAAC;AACvD,QAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,KAAK;AAAE,YAAA,OAAO,EAAE,CAAC;QAChF,IAAI,IAAI,KAAK,SAAS;AAAE,YAAA,OAAO,IAAI,CAAC;QACpC,IAAI,IAAI,KAAK,MAAM;AAAE,YAAA,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AACrD,QAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;AAAE,YAAA,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACnD,QAAA,OAAO,SAAS,CAAC;KACpB;AAEO,IAAA,sBAAsB,CAAC,QAAwB,EAAA;QACnD,MAAM,UAAU,GAAQ,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAa,EAAE,CAAC;AAE9B,QAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAG;AAC5B,YAAA,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;AAC3D,YAAA,IAAI,KAAK,CAAC,QAAQ,EAAE;AAChB,gBAAA,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC7B;AACL,SAAC,CAAC,CAAC;QAEH,OAAO;AACH,YAAA,IAAI,EAAE,QAAQ;YACd,UAAU;YACV,QAAQ;SACX,CAAC;KACL;AAEO,IAAA,qBAAqB,CAAC,KAAgB,EAAA;AAC1C,QAAA,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAExB,IAAI,IAAI,KAAK,OAAO;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACjE,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC/D,IAAI,IAAI,KAAK,KAAK;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC7D,QAAA,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;AAAE,YAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AACzD,QAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,KAAK;AAAE,YAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAChG,IAAI,IAAI,KAAK,SAAS;AAAE,YAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACnD,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AACpE,QAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;AAAE,YAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;AAE7E,QAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;KAC7B;AACJ;;;;"}
|