@pactflow/openapi-pact-comparator 1.7.1 → 1.8.1

package/dist/index.cjs

@@ -19433,7 +19433,7 @@ var Ajv$1 = /*@__PURE__*/getDefaultExportFromCjs(ajvExports);
 // a full schema can be found at https://github.com/pactflow/pact-schemas
 // but we don't use that here, because we try to be permissive with input
 const Interaction = Type.Object({
-    _skip: Type.Optional(Type.Boolean()),
+    _nonHTTP: Type.Optional(Type.Boolean()),
     type: Type.Optional(Type.String()),
     description: Type.Optional(Type.String()),
     providerState: Type.Optional(Type.String()),
@@ -19463,6 +19463,10 @@ const Interaction = Type.Object({
         status: Type.Number(),
     }),
 });
+const Message = Type.Object({
+    description: Type.Optional(Type.String()),
+    providerState: Type.Optional(Type.String()),
+});
 const Pact = Type.Object({
     metadata: Type.Optional(Type.Object({
         pactSpecification: Type.Optional(Type.Object({
@@ -19473,7 +19477,8 @@ const Pact = Type.Object({
             version: Type.String(),
         })),
     })),
-    interactions: Type.Array(Interaction),
+    interactions: Type.Optional(Type.Array(Interaction)),
+    messages: Type.Optional(Type.Array(Message)),
 });
 const supportedInteractions = (i) => !i.type || i.type.toLowerCase() === "synchronous/http";
 const parseAsPactV4Body = (body) => {
@@ -19544,13 +19549,18 @@ const interactionV4 = (i) => ({
         headers: flattenValues(i.response.headers),
     },
 });
+const interactionNonHTTP = (i) => ({
+    ...i,
+    _nonHTTP: true,
+});
 const ajv = new Ajv$1();
 const validate = ajv.compile(Pact);
 const parse = (pact) => {
-    const { metadata, interactions } = pact;
+    const { metadata, interactions, messages } = pact;
     const isValid = validate({
         metadata,
-        interactions: interactions.filter(supportedInteractions),
+        interactions: interactions?.filter(supportedInteractions),
+        messages,
     });
     if (!isValid) {
         throw new ParserError(validate.errors);
@@ -19562,9 +19572,8 @@ const parse = (pact) => {
     const interactionParser = version >= 4 ? interactionV4 : version >= 3 ? interactionV3 : interactionV1;
     return {
         metadata,
-        interactions: interactions.map((i) => supportedInteractions(i)
-            ? interactionParser(i)
-            : { _skip: true }),
+        interactions: interactions?.map((i) => supportedInteractions(i) ? interactionParser(i) : interactionNonHTTP(i)),
+        messages,
     };
 };
 class ParserError extends Error {
@@ -24345,9 +24354,19 @@ class Comparator {
             this.#router = setupRouter(this.#oas, this.#config);
         }
         const parsedPact = parse(pact);
-        for (const [index, interaction] of parsedPact.interactions.entries()) {
-            if (interaction._skip) {
-                // non http/synchronous have been zero-ed out
+        const parsedInteractions = parsedPact.interactions || [];
+        for (const [index, interaction] of parsedInteractions.entries()) {
+            if (interaction._nonHTTP) {
+                yield {
+                    code: "interaction.type.unsupported",
+                    mockDetails: {
+                        ...baseMockDetails(interaction),
+                        location: `[root].interactions[${index}].type`,
+                        value: interaction.type,
+                    },
+                    message: `Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.`,
+                    type: "warning",
+                };
                 continue;
             }
             const { method, path, query } = interaction.request;
@@ -24395,6 +24414,21 @@ class Comparator {
             yield* compareResHeader(this.#ajvCoerce, route, interaction, index, this.#config);
             yield* compareResBody(this.#ajvNocoerce, route, interaction, index, this.#config);
         }
+        if (parsedPact.messages) {
+            for (const [index, message] of parsedPact.messages.entries()) {
+                yield {
+                    code: "interaction.type.unsupported",
+                    mockDetails: {
+                        interactionDescription: message.description,
+                        interactionState: message.providerState || "[none]",
+                        location: `[root].messages[${index}]`,
+                        value: message,
+                    },
+                    message: `Non-HTTP messages cannot be verified against an HTTP-only OpenAPI Document.`,
+                    type: "warning",
+                };
+            }
+        }
     }
 }