Add support for wildcard media types

jdesrosiers · jdesrosiers · commit 2ea238a88d6f · 2024-12-20T22:39:22.000-08:00
diff --git a/lib/media-types/media-types.js b/lib/media-types/media-types.js
@@ -1,4 +1,5 @@
 import { parse as parseContentType } from "content-type";
+import { match as mediaTypeMatch } from "type-is";
 
 
 const mediaTypePlugins = {};
@@ -22,13 +23,15 @@ export const parseResponse = (response) => {
   }
 
   const contentType = parseContentType(contentTypeText);
-  if (!(contentType.type in mediaTypePlugins)) {
-    throw new UnsupportedMediaTypeError(contentType.type, `'${contentType.type}' is not supported. Use the 'addMediaTypePlugin' function to add support for this media type.`, {
-      cause: response
-    });
+  for (const pattern in mediaTypePlugins) {
+    if (mediaTypeMatch(pattern, contentType.type)) {
+      return mediaTypePlugins[pattern].parse(response);
+    }
   }
 
-  return mediaTypePlugins[contentType.type].parse(response);
+  throw new UnsupportedMediaTypeError(contentType.type, `'${contentType.type}' is not supported. Use the 'addMediaTypePlugin' function to add support for this media type.`, {
+    cause: response
+  });
 };
 
 export const getFileMediaType = async (path) => {
diff --git a/lib/media-types/media-types.spec.ts b/lib/media-types/media-types.spec.ts
@@ -1,5 +1,6 @@
 import { describe, test, beforeEach, afterEach, expect } from "vitest";
-import { addMediaTypePlugin, removeMediaTypePlugin, setMediaTypeQuality } from "../index.js";
+import { MockAgent, setGlobalDispatcher } from "undici";
+import { addMediaTypePlugin, get, removeMediaTypePlugin, setMediaTypeQuality } from "../index.js";
 import { acceptableMediaTypes } from "./media-types.js";
 
 
@@ -76,5 +77,40 @@ describe("JSON Browser", () => {
         expect(accept).to.equal("application/reference+json, application/foo; q=0.9, */*; q=0.001");
       });
     });
+
+    describe("Wildcard media type plugins", () => {
+      const testDomain = "https://example.com";
+      let mockAgent: MockAgent;
+
+      beforeEach(() => {
+        addMediaTypePlugin("application/*+foo", {
+          parse: async () => { // eslint-disable-line @typescript-eslint/require-await
+            return {
+              baseUri: "https://exmple.com/foo",
+              root: null,
+              anchorLocation: (fragment) => fragment ?? ""
+            };
+          },
+          fileMatcher: async (path) => path.endsWith(".foo") // eslint-disable-line @typescript-eslint/require-await
+        });
+
+        mockAgent = new MockAgent();
+        mockAgent.disableNetConnect();
+        setGlobalDispatcher(mockAgent);
+        mockAgent.get(testDomain)
+          .intercept({ method: "GET", path: "/foo" })
+          .reply(200, `{}`, { headers: { "content-type": "application/whatever+foo" } });
+      });
+
+      afterEach(async () => {
+        removeMediaTypePlugin("application/*+foo");
+        await mockAgent.close();
+      });
+
+      test("should match wildcard media type", async () => {
+        // Expect not to throw
+        await get(`${testDomain}/foo`);
+      });
+    });
   });
 });
diff --git a/package.json b/package.json
@@ -52,6 +52,7 @@
     "@hyperjump/json-pointer": "^1.1.0",
     "@hyperjump/uri": "^1.2.0",
     "content-type": "^1.0.5",
-    "just-curry-it": "^5.3.0"
+    "just-curry-it": "^5.3.0",
+    "type-is": "^1.6.18"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@`
`52`	`52`	`"@hyperjump/json-pointer": "^1.1.0",`
`53`	`53`	`"@hyperjump/uri": "^1.2.0",`
`54`	`54`	`"content-type": "^1.0.5",`
`55`		`- "just-curry-it": "^5.3.0"`
	`55`	`+ "just-curry-it": "^5.3.0",`
	`56`	`+ "type-is": "^1.6.18"`
`56`	`57`	`}`
`57`	`58`	`}`