fix(types): correct TypeScript type declarations to match runtime shapes#7
Closed
dmchaledev wants to merge 1 commit into
Closed
fix(types): correct TypeScript type declarations to match runtime shapes#7dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
Fixes the index.d.ts type declarations for the @hailbytes/vulnerability-calculator package. Previously, the declared types did not match the actual runtime objects: - VMResources declared cpu/ram/storage, but runtime uses cpu_cores/ram_gb/ram_recommended/storage_gb - Missing fields: network_bandwidth_mbps, docker_required, tool_type, scaling_info - VulnResult.timing and .costs were typed as Record<string, unknown> instead of proper interfaces - Missing interfaces: ScanTiming, ToolBreakdownItem, ROIAnalysis, Costs - VulnInputs was missing the required scan_window field - VulnInputs.scan_window is number, not string This fix adds proper interfaces for all runtime shapes exported by calculate(), enabling TypeScript consumers to get accurate type checking and IDE autocompletion.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the
index.d.tstype declarations for@hailbytes/vulnerability-calculatorso they accurately reflect the runtime objects returned bycalculate().What was wrong
The previous type declarations had several mismatches with the actual runtime shapes:
cpu,ram,storagecpu_cores,ram_gb,ram_recommended,storage_gbnetwork_bandwidth_mbps,docker_required,tool_type,scaling_infoscan_window: numberRecord<string, unknown>ScanTiminginterfaceRecord<string, unknown>CostsinterfaceScanTiming,ToolBreakdownItem,ROIAnalysis,CostsWhat was changed
index.d.tswith accurate interfaces matching the actual runtime output ofcalculate()Impact
TypeScript consumers importing
@hailbytes/vulnerability-calculatorwill now get:calculate()return valuesvm_resources.*,timing.*,costs.*