feat(messages): implement v3 compatible provider states

src/dsl/matchers.spec.ts

@@ -531,7 +531,7 @@ describe("Matcher", () => {
         });
       });
       describe("when given a complex nested object with matchers", () => {
-        it.only("should remove all matching guff", () => {
+        it("should remove all matching guff", () => {
           const o = somethingLike({
             stringMatcher: {
               awesomeSetting: somethingLike("a string"),

src/dsl/message.ts

@@ -17,7 +17,7 @@ export interface Metadata { [name: string]: string | MatcherResult; }
  * @module Message
  */
 export interface Message {
-  providerState?: string;
+  providerStates?: string;
   description?: string;
   metadata?: Metadata;
   content: any;

src/messageConsumer.spec.ts

@@ -47,6 +47,18 @@ describe("MessageConsumer", () => {
         return expect(consumer.validate()).to.eventually.be.fulfilled;
       });
     });
+    describe("when a valid state has been given", () => {
+      it("the state should be save id in v3 format", () => {
+        consumer
+          .given("some state")
+          .expectsToReceive("A message about something")
+          .withContent({ foo: "bar" })
+          .withMetadata({ baz: "bat" });
+
+        expect(consumer.json().providerStates).to.be.a("array");
+        expect(consumer.json().providerStates).to.deep.eq([{ name: "some state" }]);
+      });
+    });
     describe("when a valid Message has not been constructed", () => {
       it("the state should not be valid", () => {
         consumer

src/messageConsumer.ts

@@ -36,7 +36,12 @@ export class MessageConsumer {
    */
   public given(providerState: string) {
     if (providerState) {
-      this.state.providerState = providerState;
+      // Currently only supports a single state
+      // but the format needs to be v3 compatible for
+      // basic interoperability
+      this.state.providerStates = [{
+        name: providerState,
+      }];
     }
 
     return this;