@pactflow/openapi-pact-comparator 1.8.0 → 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({
@@ -19474,7 +19478,7 @@ const Pact = Type.Object({
         })),
     })),
     interactions: Type.Optional(Type.Array(Interaction)),
-    messages: Type.Optional(Type.Array(Type.Unknown())),
+    messages: Type.Optional(Type.Array(Message)),
 });
 const supportedInteractions = (i) => !i.type || i.type.toLowerCase() === "synchronous/http";
 const parseAsPactV4Body = (body) => {
@@ -19545,6 +19549,10 @@ 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) => {
@@ -19564,9 +19572,7 @@ 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,
     };
 };
@@ -24349,14 +24355,18 @@ class Comparator {
         }
         const parsedPact = parse(pact);
         const parsedInteractions = parsedPact.interactions || [];
-        const UNSUPPORTED_INTERACTION_WARNING = {
-            code: "interaction.type.unsupported",
-            message: `Non-HTTP Interaction is not supported, OPC can only compare HTTP interactions.`,
-            type: "warning",
-        };
         for (const [index, interaction] of parsedInteractions.entries()) {
-            if (interaction._skip) {
-                yield UNSUPPORTED_INTERACTION_WARNING;
+            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;
@@ -24405,8 +24415,18 @@ class Comparator {
             yield* compareResBody(this.#ajvNocoerce, route, interaction, index, this.#config);
         }
         if (parsedPact.messages) {
-            for (const [_message] of parsedPact.messages.entries()) {
-                yield UNSUPPORTED_INTERACTION_WARNING;
+            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",
+                };
             }
         }
     }