Initial commit

Author: zefman

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  rules: {
+    'no-console': 'off',
+    'func-names': 'off'
+  },
+};

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.vscode
+.cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jozef Maxted
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# @zefman/gridsome-source-webmentions
+
+> Webmentions source for Gridsome 💬
+
+Loads webmentions from [https://webmention.io](https://webmention.io)
+
+I will write a tutorial soon on how to set up webmentions with Gridsome using this plugin, in the meantime if you don't know what a webmention is give 
+this a read: (https://en.wikipedia.org/wiki/Webmention)[https://en.wikipedia.org/wiki/Webmention]
+
+## Install
+- `npm install @zefman/gridsome-source-webmentions`
+- `yarn add @zefman/gridsome-source-webmentions`
+
+## Usage
+
+Add the plugin in `gridsome.config.js`
+
+```js
+export default {
+  plugins: [
+    {
+      use: '@zefman/gridsome-source-webmentions',
+      options: {
+        domain: 'pixelhop.io', // Your webmention domain
+        token: 'your-token', // Your secret webmention token
+      },
+    }
+  ]
+}
+```
+
+Example query to load a pages webmentions
+
+```
+<page-query>
+  query($path: String!) {
+    mentions: allWebMention(filter: { wmTarget: { regex: $path } }) {
+      edges {
+        node {
+          wmId
+          url
+          wmProperty
+          wmSource
+          content {
+            text
+          }
+          author {
+            name
+            photo
+            url
+          }
+        }
+      }
+    }
+  }
+</page-query>
+```
+
+## Todo
+
+* Write blog post explaining usage
+* Handle webmention.io pagination. Currently limited to 2000 mentions

index.js

@@ -0,0 +1,42 @@
+const axios = require('axios');
+const camelcaseKeys = require('camelcase-keys');
+
+// get all mentions for a token and a specific domain
+const getMentions = async ({ domain, token }) => axios
+  .get(
+    `https://webmention.io/api/mentions.jf2?domain=${domain}&token=${token}&per-page=2000`,
+  )
+  .then((response) => response.data)
+  .then((mentions) => {
+    if (!mentions || !mentions.children) {
+      return [];
+    }
+    // For entries to be automatically created the keys in the
+    // objects need to be in camelcase
+    return camelcaseKeys(mentions.children);
+  });
+
+module.exports = function (api, options) {
+  api.loadSource(async ({ addCollection }) => {
+    const contentType = addCollection({
+      typeName: options.typeName,
+    });
+
+    try {
+      const mentions = await getMentions(options);
+
+      mentions.forEach((mention) => {
+        contentType.addNode(mention);
+      });
+
+      console.log(`💬 Added ${mentions.length} web mentions`);
+    } catch (error) {
+      console.error('Error getting web mentions');
+      console.error(error);
+    }
+  });
+};
+
+module.exports.defaultOptions = () => ({
+  typeName: 'WebMention',
+});