@pactflow/openapi-pact-comparator 2.2.0 → 2.3.0

package/dist/index.cjs

@@ -3914,8 +3914,23 @@ const splitPath = (path) => {
     }
     return path;
 };
-const dereferenceOas = (schema, oas) => (schema.$ref ? get$1(oas, splitPath(schema.$ref)) : schema);
-const dereferenceDoc = (schema, doc) => schema.$ref ? get$1(doc, splitPath(schema.$ref)) : schema;
+const followRefChain = (schema, doc, seen = new Set()) => {
+    if (!schema.$ref)
+        return { value: schema, ref: undefined };
+    if (seen.has(schema.$ref))
+        return { value: undefined, ref: undefined };
+    const resolved = get$1(doc, splitPath(schema.$ref));
+    if (resolved !== null && typeof resolved === "object" && "$ref" in resolved) {
+        const next = followRefChain(resolved, doc, new Set([...seen, schema.$ref]));
+        return next.value !== undefined
+            ? { value: next.value, ref: next.ref ?? schema.$ref }
+            : next;
+    }
+    return { value: resolved, ref: schema.$ref };
+};
+const dereferenceOas = (schema, oas) => (followRefChain(schema, oas).value ?? schema);
+const dereferenceDoc = (schema, doc) => followRefChain(schema, doc).value;
+const lastRefInChain = (schema, doc) => followRefChain(schema, doc).ref;
 const traverse = (schema, visitor) => {
     if (typeof schema === "boolean" || schema === undefined) {
         return;
@@ -3999,7 +4014,8 @@ function* iterateMessageList(messages, inlinePathBase, cache, doc) {
             const message = dereferenceDoc(ref, doc);
             if (!message)
                 continue;
-            const path = "[root]." + ref.$ref.replace(/^#\//, "").replace(/\//g, ".");
+            const finalRef = lastRefInChain(ref, doc) ?? ref.$ref;
+            const path = "[root]." + finalRef.replace(/^#\//, "").replace(/\//g, ".");
             const result = { message, path };
             cache.set(ref.$ref, result);
             yield result;
@@ -4512,12 +4528,13 @@ function checkAsyncapiPreamble(asyncapi, interaction, index, interactionKind) {
             },
         };
     }
+    const interactionKindTitleCase = `${interactionKind.charAt(0).toUpperCase()}${interactionKind.slice(1)}`;
     if (!interaction.asyncapiReferences) {
         return {
             ok: false,
             result: {
                 code: "message.references.missing",
-                message: `${interactionKind.charAt(0).toUpperCase()}${interactionKind.slice(1)} interaction has no AsyncAPI references in comments.references.AsyncAPI`,
+                message: `${interactionKindTitleCase} interaction has no AsyncAPI references in comments.references.AsyncAPI`,
                 mockDetails: {
                     ...baseMockDetails(interaction),
                     location: `[root].interactions[${index}].comments.references.AsyncAPI`,
@@ -4529,6 +4546,22 @@ function checkAsyncapiPreamble(asyncapi, interaction, index, interactionKind) {
         };
     }
     const { operationId } = interaction.asyncapiReferences;
+    if (!operationId) {
+        return {
+            ok: false,
+            result: {
+                code: "message.references.missing",
+                message: `${interactionKindTitleCase} interaction has a malformed AsyncAPI reference in comments.references.AsyncAPI: expected an "operationId" property`,
+                mockDetails: {
+                    ...baseMockDetails(interaction),
+                    location: `[root].interactions[${index}].comments.references.AsyncAPI`,
+                    value: interaction.asyncapiReferences,
+                },
+                specDetails: { location: "[root]", value: undefined },
+                type: "error",
+            },
+        };
+    }
     if (!asyncapi.operations?.[operationId]) {
         return {
             ok: false,
@@ -6825,7 +6858,10 @@ function requireSideChannel () {
 		var channel = {
 			assert: function (key) {
 				if (!channel.has(key)) {
-					throw new $TypeError('Side channel does not contain ' + inspect(key));
+					var keyDesc = key && Object(key) === key
+						? 'the given object key'
+						: inspect(key);
+					throw new $TypeError('Side channel does not contain ' + keyDesc);
 				}
 			},
 			'delete': function (key) {
@@ -6845,7 +6881,7 @@ function requireSideChannel () {
 				$channelData.set(key, value);
 			}
 		};
-		// @ts-expect-error TODO: figure out why this is erroring
+
 		return channel;
 	};
 	return sideChannel;
@@ -6891,6 +6927,7 @@ function requireUtils$1 () {
 
 	var formats = /*@__PURE__*/ requireFormats$1();
 	var getSideChannel = requireSideChannel();
+	var defineProperty = /*@__PURE__*/ requireEsDefineProperty();
 
 	var has = Object.prototype.hasOwnProperty;
 	var isArray = Array.isArray;
@@ -6955,6 +6992,19 @@ function requireUtils$1 () {
 	    return obj;
 	};
 
+	var setProperty = function setProperty(obj, key, value) {
+	    if (key === '__proto__' && defineProperty) {
+	        defineProperty(obj, key, {
+	            configurable: true,
+	            enumerable: true,
+	            value: value,
+	            writable: true
+	        });
+	    } else {
+	        obj[key] = value;
+	    }
+	};
+
 	var merge = function merge(target, source, options) {
 	    /* eslint no-param-reassign: 0 */
 	    if (!source) {
@@ -6964,7 +7014,10 @@ function requireUtils$1 () {
 	    if (typeof source !== 'object' && typeof source !== 'function') {
 	        if (isArray(target)) {
 	            var nextIndex = target.length;
-	            if (options && typeof options.arrayLimit === 'number' && nextIndex > options.arrayLimit) {
+	            if (options && typeof options.arrayLimit === 'number' && nextIndex >= options.arrayLimit) {
+	                if (options.throwOnLimitExceeded) {
+	                    throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	                }
 	                return markOverflow(arrayToObject(target.concat(source), options), nextIndex);
 	            }
 	            target[nextIndex] = source;
@@ -7004,6 +7057,9 @@ function requireUtils$1 () {
 	        }
 	        var combined = [target].concat(source);
 	        if (options && typeof options.arrayLimit === 'number' && combined.length > options.arrayLimit) {
+	            if (options.throwOnLimitExceeded) {
+	                throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	            }
 	            return markOverflow(arrayToObject(combined, options), combined.length - 1);
 	        }
 	        return combined;
@@ -7027,6 +7083,12 @@ function requireUtils$1 () {
 	                target[i] = item;
 	            }
 	        });
+	        if (options && typeof options.arrayLimit === 'number' && target.length > options.arrayLimit) {
+	            if (options.throwOnLimitExceeded) {
+	                throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	            }
+	            return markOverflow(arrayToObject(target, options), target.length - 1);
+	        }
 	        return target;
 	    }
 
@@ -7034,9 +7096,9 @@ function requireUtils$1 () {
 	        var value = source[key];
 
 	        if (has.call(acc, key)) {
-	            acc[key] = merge(acc[key], value, options);
+	            setProperty(acc, key, merge(acc[key], value, options));
 	        } else {
-	            acc[key] = value;
+	            setProperty(acc, key, value);
 	        }
 
 	        if (isOverflow(source) && !isOverflow(acc)) {
@@ -7055,7 +7117,7 @@ function requireUtils$1 () {
 
 	var assign = function assignSingleSource(target, source) {
 	    return Object.keys(source).reduce(function (acc, key) {
-	        acc[key] = source[key];
+	        setProperty(acc, key, source[key]);
 	        return acc;
 	    }, target);
 	};
@@ -7101,6 +7163,13 @@ function requireUtils$1 () {
 	    var out = '';
 	    for (var j = 0; j < string.length; j += limit) {
 	        var segment = string.length >= limit ? string.slice(j, j + limit) : string;
+	        if (j + limit < string.length) {
+	            var last = segment.charCodeAt(segment.length - 1);
+	            if (last >= 0xD800 && last <= 0xDBFF) {
+	                segment = segment.slice(0, -1);
+	                j -= 1;
+	            }
+	        }
 	        var arr = [];
 
 	        for (var i = 0; i < segment.length; ++i) {
@@ -7154,7 +7223,7 @@ function requireUtils$1 () {
 
 	var compact = function compact(value) {
 	    var queue = [{ obj: { o: value }, prop: 'o' }];
-	    var refs = [];
+	    var refs = getSideChannel();
 
 	    for (var i = 0; i < queue.length; ++i) {
 	        var item = queue[i];
@@ -7164,9 +7233,9 @@ function requireUtils$1 () {
 	        for (var j = 0; j < keys.length; ++j) {
 	            var key = keys[j];
 	            var val = obj[key];
-	            if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+	            if (typeof val === 'object' && val !== null && !refs.has(val)) {
 	                queue[queue.length] = { obj: obj, prop: key };
-	                refs[refs.length] = val;
+	                refs.set(val, true);
 	            }
 	        }
 	    }
@@ -7188,9 +7257,12 @@ function requireUtils$1 () {
 	    return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
 	};
 
-	var combine = function combine(a, b, arrayLimit, plainObjects) {
+	var combine = function combine(a, b, arrayLimit, plainObjects, throwOnLimitExceeded) {
 	    // If 'a' is already an overflow object, add to it
 	    if (isOverflow(a)) {
+	        if (throwOnLimitExceeded) {
+	            throw new RangeError('Array limit exceeded. Only ' + arrayLimit + ' element' + (arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	        }
 	        var newIndex = getMaxIndex(a) + 1;
 	        a[newIndex] = b;
 	        setMaxIndex(a, newIndex);
@@ -7199,6 +7271,9 @@ function requireUtils$1 () {
 
 	    var result = [].concat(a, b);
 	    if (result.length > arrayLimit) {
+	        if (throwOnLimitExceeded) {
+	            throw new RangeError('Array limit exceeded. Only ' + arrayLimit + ' element' + (arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	        }
 	        return markOverflow(arrayToObject(result, { plainObjects: plainObjects }), result.length - 1);
 	    }
 	    return result;
@@ -7646,8 +7721,19 @@ function requireParse$1 () {
 	    });
 	};
 
-	var parseArrayValue = function (val, options, currentArrayLength) {
+	var parseArrayValue = function (val, options, currentArrayLength, isFlatArrayValue) {
 	    if (val && typeof val === 'string' && options.comma && val.indexOf(',') > -1) {
+	        if (isFlatArrayValue && options.throwOnLimitExceeded) {
+	            var commaCount = 0;
+	            var commaIndex = val.indexOf(',');
+	            while (commaIndex > -1) {
+	                commaCount += 1;
+	                if (commaCount >= options.arrayLimit) {
+	                    throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
+	                }
+	                commaIndex = val.indexOf(',', commaIndex + 1);
+	            }
+	        }
 	        return val.split(',');
 	    }
 
@@ -7724,7 +7810,8 @@ function requireParse$1 () {
 	                    parseArrayValue(
 	                        part.slice(pos + 1),
 	                        options,
-	                        isArray(obj[key]) ? obj[key].length : 0
+	                        isArray(obj[key]) ? obj[key].length : 0,
+	                        part.indexOf('[]=') === -1
 	                    ),
 	                    function (encodedVal) {
 	                        return options.decoder(encodedVal, defaults.decoder, charset, 'value');
@@ -7742,10 +7829,7 @@ function requireParse$1 () {
 	        }
 
 	        if (options.comma && isArray(val) && val.length > options.arrayLimit) {
-	            if (options.throwOnLimitExceeded) {
-	                throw new RangeError('Array limit exceeded. Only ' + options.arrayLimit + ' element' + (options.arrayLimit === 1 ? '' : 's') + ' allowed in an array.');
-	            }
-	            val = utils.combine([], val, options.arrayLimit, options.plainObjects);
+	            val = utils.combine([], val, options.arrayLimit, options.plainObjects, options.throwOnLimitExceeded);
 	        }
 
 	        if (key !== null) {
@@ -7755,7 +7839,8 @@ function requireParse$1 () {
 	                    obj[key],
 	                    val,
 	                    options.arrayLimit,
-	                    options.plainObjects
+	                    options.plainObjects,
+	                    options.throwOnLimitExceeded
 	                );
 	            } else if (!existing || options.duplicates === 'last') {
 	                obj[key] = val;
@@ -7790,7 +7875,8 @@ function requireParse$1 () {
 	                        [],
 	                        leaf,
 	                        options.arrayLimit,
-	                        options.plainObjects
+	                        options.plainObjects,
+	                        options.throwOnLimitExceeded
 	                    );
 	            }
 	        } else {
@@ -8195,7 +8281,8 @@ function* compareReqHeader(ajv, route, interaction, index, config) {
         Object.entries(operation.responses).reduce((acc, [_status, response]) => {
             return [
                 ...acc,
-                ...Object.keys(dereferenceOas(response || {}, oas)?.content || {}),
+                ...Object.keys(dereferenceOas(response || {}, oas)
+                    ?.content || {}),
             ];
         }, []);
     const availableResponseContentType = operation.produces ||
@@ -17254,7 +17341,7 @@ function requireFastUri () {
 	      if (parsed.host && (options.domainHost || (schemeHandler && schemeHandler.domainHost)) && isIP === false && nonSimpleDomain(parsed.host)) {
 	        // convert Unicode IDN -> ASCII IDN
 	        try {
-	          parsed.host = URL.domainToASCII(parsed.host.toLowerCase());
+	          parsed.host = new URL('http://' + parsed.host).hostname;
 	        } catch (e) {
 	          parsed.error = parsed.error || "Host's domain name can not be converted to ASCII: " + e;
 	        }
@@ -20414,9 +20501,7 @@ const AsyncMessage = Type.Object({
     metadata: Type.Optional(Type.Record(Type.String(), Type.String())),
     comments: Type.Optional(Type.Object({
         references: Type.Optional(Type.Object({
-            AsyncAPI: Type.Optional(Type.Object({
-                operationId: Type.String(),
-            })),
+            AsyncAPI: Type.Optional(Type.Unknown()),
         })),
     })),
 });
@@ -20436,9 +20521,7 @@ const SyncMessage = Type.Object({
     response: Type.Array(SyncMessageSide),
     comments: Type.Optional(Type.Object({
         references: Type.Optional(Type.Object({
-            AsyncAPI: Type.Optional(Type.Object({
-                operationId: Type.String(),
-            })),
+            AsyncAPI: Type.Optional(Type.Unknown()),
         })),
     })),
 });
@@ -20528,29 +20611,32 @@ const interactionV4 = (i) => ({
         headers: flattenValues(i.response?.headers),
     },
 });
+const asAsyncapiReferences = (asyncapiRef) => {
+    if (!asyncapiRef)
+        return undefined;
+    if (typeof asyncapiRef !== "object")
+        return {};
+    return { ...asyncapiRef };
+};
 const parseAsyncInteraction = (i) => {
-    const asyncapiRef = i.comments?.references?.AsyncAPI;
+    const asyncapiRef = asAsyncapiReferences(i.comments?.references?.AsyncAPI);
     return {
         _kind: "async",
         description: i.description,
         providerState: i.providerState,
-        asyncapiReferences: asyncapiRef
-            ? { operationId: asyncapiRef.operationId }
-            : undefined,
+        asyncapiReferences: asyncapiRef,
         payload: parseAsPactV4Body(i.contents),
         contentType: i.contents?.contentType,
         metadata: i.metadata,
     };
 };
 const parseSyncInteraction = (i) => {
-    const asyncapiRef = i.comments?.references?.AsyncAPI;
+    const asyncapiRef = asAsyncapiReferences(i.comments?.references?.AsyncAPI);
     return {
         _kind: "sync",
         description: i.description,
         providerState: i.providerState,
-        asyncapiReferences: asyncapiRef
-            ? { operationId: asyncapiRef.operationId }
-            : undefined,
+        asyncapiReferences: asyncapiRef,
         request: {
             payload: parseAsPactV4Body(i.request.contents),
             contentType: i.request.contents?.contentType,