feat(core)!: Removed the assumption that every interaction response can be described by "returns". This is a breaking change, because it needs contracts to be re-written, and http contracts with automatically named triggers will have to change triggers from \"a (200) ..."\ to \"returns a (200) ..."\. If you need to stay compatible with contracts from before this version, you will need to provide both names in your trigger definitions

Author: TimothyJones

package-lock.json

@@ -70,7 +70,7 @@ const describe = (
   context: MatchContext,
 ): string =>
   isSuccessResult(matcher)
-    ? `returning ${context.descendAndDescribe(
+    ? `returns ${context.descendAndDescribe(
         matcher.success,
         addLocation(`returnValue`, context),
       )}`

packages/case-core-plugin-function/src/matchers/FunctionResultMatcher.ts

@@ -94,8 +94,8 @@ const name = (
   context: MatchContext,
 ): string =>
   response.uniqueName
-    ? response.uniqueName
-    : `a (${context.descendAndDescribe(
+    ? `returns ${response.uniqueName}`
+    : `returns a (${context.descendAndDescribe(
         response.status,
         addLocation('status', context),
       )}) response ${

packages/case-core-plugin-http/src/matchers/HttpResponseMatcher.ts

@@ -126,7 +126,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (200) response with body an object shaped like {status: \"up\"}",
+          "_case:matcher:uniqueName": "returns a (200) response with body an object shaped like {status: \"up\"}",
           "_case:matcher:child": {
             "status": 200,
             "body": {
@@ -170,7 +170,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (200) response with body an object shaped like {status: <any string>}",
+          "_case:matcher:uniqueName": "returns a (200) response with body an object shaped like {status: <any string>}",
           "_case:matcher:child": {
             "status": 200,
             "body": {
@@ -218,7 +218,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (httpStatus 4XX | 5XX) response without a body",
+          "_case:matcher:uniqueName": "returns a (httpStatus 4XX | 5XX) response without a body",
           "_case:matcher:child": {
             "status": {
               "_case:matcher:type": "_case:HttpStatusCode",
@@ -264,7 +264,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (503) response with body an object shaped like {status: \"down\"}",
+          "_case:matcher:uniqueName": "returns a (503) response with body an object shaped like {status: \"down\"}",
           "_case:matcher:child": {
             "status": 503,
             "body": {
@@ -327,7 +327,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (200) response with body an object shaped like {userId: ${userId}}",
+          "_case:matcher:uniqueName": "returns a (200) response with body an object shaped like {userId: ${userId}}",
           "_case:matcher:child": {
             "status": 200,
             "body": {
@@ -383,7 +383,7 @@
         },
         "response": {
           "_case:matcher:type": "_case:Lookup",
-          "_case:matcher:uniqueName": "a (404) response without a body",
+          "_case:matcher:uniqueName": "returns a (404) response without a body",
           "_case:matcher:child": {
             "status": 404,
             "_case:matcher:type": "_case:HttpResponseMatcher"