v5.0.0

5.0.0 - 2023-02-27

Changed

• @superfaceai/one-sdk peer dependency from ^2.3 to ^2.4

v4.0.0

4.0.0 - 2023-02-08

Changed

• @superfaceai/one-sdk peer dependency from ^2.0 to ^2.3
• @superfaceai/parser peer dependency from ^1.2.0 to ^2.1.0

v4.0.0-beta.0

chore: release v4.0.0-beta.0

v4.1.0-beta.0

chore: release v4.1.0-beta.0

v4.0.0-rc.0

chore: release v4.0.0-rc.0

v3.0.0

3.0.0 - 2022-12-07

Added

• New parameter recordingType in method run() to differentiate between prepare, teardown or main test run
• New dev and peer dependency - Superface Parser v1.2.0
• New module for preparing files necessary for perform (SuperJson, ProfileAST, MapAST, ProviderJson)
• New module for mocking necessary files for perform
• Support hiding of credentials used with new security scheme Digest
• New parameter fullError in method run() to enable returning whole PerformError instead of string
• New static function report in SuperfaceTest to report found provider changes
• Module matcher for comparing old and new HTTP traffic
• Module analyzer for determining impact of provider changes
• Module reporter for reporting provider changes throughout tests
• Class ErrorCollector for collecting errors in matcher
• Environment variable UPDATE_TRAFFIC to replace old traffic with new, if present
• Environment variable DISABLE_PROVIDER_CHANGES_COVERAGE to disable collecting of test reports
• Environment variable USE_NEW_TRAFFIC to test with newly recorded traffic
• Environment variable DECODE_RESPONSE to save recordings with decoded response next to original one
• Errors for module matcher
• Error CoverageFileNotFoundError for correct reporting

Changed

• BREAKING CHANGE: Recording fixtures are grouped by test file or provider
• BREAKING CHANGE: Recording fixtures are stored next to test file OR in <project-dir>/recordings/<profile>/<provider>.recording.json
• BREAKING CHANGE: Updated One-SDK to v2.0.0
• BREAKING CHANGE: Use BoundProfileProvider instead of using client and use-case to run perform -> Local use only
• Move functions used for recording in SuperfaceTest to seperate module
• Use SecurityConfiguration (containing merged SecurityValue and SecurityScheme interfaces) instead of using them separately
• Move parameter testInstance from superface components to second parameter in constructor
• Return value from method run to PerformError | string
• Does not overwrite HTTP traffic recording when in record mode, instead save new one next to old one with suffix -new

Removed

• Parameter client from constructor and method run
• Function for omitting timestamp from perform error removeTimestamp

v3.0.0-rc.2

chore: release v3.0.0-rc.2

v3.0.0-rc.1

chore: release v3.0.0-rc.1

v3.0.0-beta.5

chore: release v3.0.0-beta.5

v3.0.0-rc.0

chore: release v3.0.0-rc.0