feat(plugin): Support service-specific options (#58)

* wip: poc for twitter url parameters

* only pass relevant options

* add instagram custom parameter support

* document service-specific options

* add tests

* refactor: move query parameters into sub object

* add general service-specific info

* rebase and remove queryparams name

* update docs example

* fix: import url constructor

* refactor: nest and document params object

* the quotes are on purpose

* fix: import urlsearchparams constructor

* feat: only implement plugin-specific-options mechanism

* docs: removed old option docs

* chore: remove unused imports

* chore: remove unused imports

* Update README

* Update transformers

* Update plugin

* Update tests

* test: transformer options

* test: generalize

* Update src/__tests__/plugin.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update src/__tests__/plugin.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update src/index.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update src/index.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update src/__tests__/plugin.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update src/__tests__/plugin.js

Co-Authored-By: Michaël De Boey <info@michaeldeboey.be>

* Update docs

Co-authored-by: Michaël De Boey <info@michaeldeboey.be>

Author: NickyMeuleman

README.md

@@ -596,7 +596,7 @@ Each element of the array should be an object with two methods that receive the
 URL argument:
 
 - `shouldTransform(url)`
-- `getHTML(url)`
+- `getHTML(url, options)`
 
 The `shouldTransform` method should check if the URL matches the one intended to
 transform; it should to return a boolean value.
@@ -678,6 +678,7 @@ Thanks goes to these people ([emoji key][emojis]):
 
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors][all-contributors] specification.

src/__tests__/__fixtures__/ServiceTransformer.md

@@ -0,0 +1 @@
+https://some-site.com/id/abc

src/__tests__/plugin.js

@@ -1,3 +1,5 @@
+import cases from 'jest-in-case';
+
 import plugin from '../';
 
 import {
@@ -90,4 +92,39 @@ describe('gatsby-remark-embedder', () => {
 An error occurred in ErrorTransformer]
 `);
   });
+
+  cases(
+    'passes service-specific options to the transformers',
+    async ({ name, passedOptions }) => {
+      const transformer = {
+        getHTML: jest.fn(),
+        name,
+        shouldTransform: () => true,
+      };
+
+      const markdownAST = getMarkdownASTForFile('ServiceTransformer', true);
+
+      await plugin(
+        { cache, markdownAST },
+        {
+          customTransformers: [transformer],
+          services: { serviceTransformer: { service: 'transformer' } },
+        }
+      );
+
+      expect(transformer.getHTML).toHaveBeenCalledWith(
+        'https://some-site.com/id/abc',
+        passedOptions
+      );
+    },
+    {
+      'transformer with name': {
+        name: 'serviceTransformer',
+        passedOptions: { service: 'transformer' },
+      },
+      'transformer without name': {
+        passedOptions: {},
+      },
+    }
+  );
 });

src/index.js

@@ -15,7 +15,7 @@ const getUrlString = url => {
 
 export default async (
   { cache, markdownAST },
-  { customTransformers = [] } = {}
+  { customTransformers = [], services = {} } = {}
 ) => {
   const transformers = [...defaultTransformers, ...customTransformers];
 
@@ -46,13 +46,13 @@ export default async (
 
     transformers
       .filter(({ shouldTransform }) => shouldTransform(urlString))
-      .forEach(({ getHTML }) => {
+      .forEach(({ getHTML, name = '' }) => {
         transformations.push(async () => {
           try {
             let html = await cache.get(urlString);
 
             if (!html) {
-              html = await getHTML(urlString);
+              html = await getHTML(urlString, services[name] || {});
               await cache.set(urlString, html);
             }