Merge pull request #24 from microcmsio/fix/update-x-microcms-api-key

shibe97 · web-flow · commit 8f1cc1b86fa8 · 2021-10-25T16:09:01.000+09:00
X-MICROCMS-API-KEY対応
diff --git a/README.md b/README.md
@@ -29,9 +29,11 @@ module.exports = {
       options: {
         apiKey: 'MICROCMS_API_KEY',
         serviceId: 'myblog',
-        apis: [{
-          endpoint: 'posts',
-        }],
+        apis: [
+          {
+            endpoint: 'posts',
+          },
+        ],
       },
     },
   ],
@@ -92,14 +94,6 @@ module.exports = {
          **/
         apiKey: '11111111-2222-3333-4444-555555555555',
 
-        /**
-         * Global draft key.
-         * If you set this key, you can get all draft contents.
-         *
-         * Type: string.
-         **/
-        globalDraftKey: '11111111-2222-3333-4444-555555555555',
-
         /**
          * Service information. (Required)
          * xxxx.microcms.io
@@ -114,55 +108,57 @@ module.exports = {
          *
          * Type: array.
          **/
-        apis: [{
-          /**
-           * API endpoint name. (Required)
-           * https://xxxx.microcms.io/api/v1/posts
-           *
-           * Type: string.
-           **/
-          endpoint: 'posts',
-
-          /**
-           * Graphql type. (Optional)
-           * This is used in GraphQL queries.
-           * If type = 'post', the GraphQL types are named 'microcmsPost' and 'allMicrocmsPost'.
-           *
-           * Type: string.
-           * Default: endpoint value.
-           **/
-          type: 'post',
-
-          /**
-           * microCMS's content type('list' or 'object'). (Optional)
-           * if format is 'list', read all contents by fetching multiple times.
-           *
-           * Type: string.
-           * Default: 'list'.
-           **/
-          format: 'object',
-
-          /**
-           * API request query options. (Optional)
-           *
-           * Type:
-           *   draftKey: string.
-           *   limit: number.
-           *   offset: number.
-           *   fields: string.
-           *   filters: string.
-           *   depth: number.
-           * Default: {}.
-           **/
-          query: {
-            draftKey: 'DRAFT_KEY',
-            limit: 100,
-            offset: 40,
-            fields: ['id', 'title', 'body'].join(','),
-            filters: 'tag[exists]',
-            depth: 2
-          }
-        }],
+        apis: [
+          {
+            /**
+             * API endpoint name. (Required)
+             * https://xxxx.microcms.io/api/v1/posts
+             *
+             * Type: string.
+             **/
+            endpoint: 'posts',
+
+            /**
+             * Graphql type. (Optional)
+             * This is used in GraphQL queries.
+             * If type = 'post', the GraphQL types are named 'microcmsPost' and 'allMicrocmsPost'.
+             *
+             * Type: string.
+             * Default: endpoint value.
+             **/
+            type: 'post',
+
+            /**
+             * microCMS's content type('list' or 'object'). (Optional)
+             * if format is 'list', read all contents by fetching multiple times.
+             *
+             * Type: string.
+             * Default: 'list'.
+             **/
+            format: 'object',
+
+            /**
+             * API request query options. (Optional)
+             *
+             * Type:
+             *   draftKey: string.
+             *   limit: number.
+             *   offset: number.
+             *   fields: string.
+             *   filters: string.
+             *   depth: number.
+             * Default: {}.
+             **/
+            query: {
+              draftKey: 'DRAFT_KEY',
+              limit: 100,
+              offset: 40,
+              fields: ['id', 'title', 'body'].join(','),
+              filters: 'tag[exists]',
+              depth: 2,
+            },
+          },
+        ],
       },
     },
   ],
@@ -175,81 +171,86 @@ This plugin provides [filters query](https://microcms.io/blog/filters-parameter/
 
 ```js
 // gatsby-config.js
-const { and, contains, exists } = require('gatsby-source-microcms/src/query-builder');
+const {
+  and,
+  contains,
+  exists,
+} = require('gatsby-source-microcms/src/query-builder');
 
 module.exports = {
   plugins: [
     {
       resolve: 'gatsby-source-microcms',
       options: {
-        apis: [{
-          query: {
-            filters: and(contains('title', 'sale'), exists('tag')),
-            //=> `title[contains]sale[and]tag[exists]`
-          }
-        }]
+        apis: [
+          {
+            query: {
+              filters: and(contains('title', 'sale'), exists('tag')),
+              //=> `title[contains]sale[and]tag[exists]`
+            },
+          },
+        ],
       },
     },
   ],
 };
-
 ```
 
 Helper list:
 
 - `equals` (alias: `eq`)
 
 ```js
-equals('gender', 'women')
+equals('gender', 'women');
 //=> gender[equals]women
 ```
 
 - `notEquals` (alias: `neq`)
 
 ```js
-notEquals('gender', 'women')
+notEquals('gender', 'women');
 //=> gender[not_equals]women
 ```
 
 - `lessThan` (alias: `lg`)
 
 ```js
-lessThan('createdAt', '2019-11')
+lessThan('createdAt', '2019-11');
 //=> createdAt[less_than]2019-11
 ```
 
 - `greaterThan` (alias: `gt`)
 
 ```js
-greaterThan('createdAt', '2019-11')
+greaterThan('createdAt', '2019-11');
 //=> createdAt[greater_than]2019-11
 ```
 
 - `contains`
 
 ```js
-contains('title', 'sale')
+contains('title', 'sale');
 //=> title[contains]sale
 ```
 
 - `exists`
 
 ```js
-exists('nextLink')
+exists('nextLink');
 //=> nextLink[exists]
 ```
 
 - `notExists`
 
 ```js
-notExists('nextLink')
+notExists('nextLink');
 //=> nextLink[not_exists]
 ```
 
 - `beginsWith`
 
 ```js
-beginsWith('publishedAt', '2019-11')
+beginsWith('publishedAt', '2019-11');
 //=> publishedAt[begins_with]2019-11
 ```
 
@@ -268,5 +269,6 @@ or('filter1', 'filter2', ..., 'filter10')
 ```
 
 ## Contributing
-日本語歓迎🇯🇵
-Pull Request, Issueお気軽にどうぞ。
+
+日本語歓迎 🇯🇵
+Pull Request, Issue お気軽にどうぞ。
diff --git a/example/gatsby-config.js b/example/gatsby-config.js
@@ -2,7 +2,6 @@ require('dotenv').config();
 
 // We prepared one service to make it easy for anyone to develop.
 const MICROCMS_API_KEY = 'dc59f358-4622-471f-8d1e-6c7a6f969558';
-const MICROCMS_GLOBAL_DRAFT_KEY = '0523713e-efeb-4aec-87fd-12c58588c4e3';
 const MICROCMS_SERVICE_ID = 'example';
 
 const { and, equals, exists, notExists } = require('../src/query-builder');
@@ -18,7 +17,6 @@ module.exports = {
       resolve: require.resolve('../gatsby-node'),
       options: {
         apiKey: process.env.MICROCMS_API_KEY || MICROCMS_API_KEY,
-        globalDraftKey: process.env.MICROCMS_GLOBAL_DRAFT_KEY || MICROCMS_GLOBAL_DRAFT_KEY,
         serviceId: process.env.MICROCMS_SERVICE_ID || MICROCMS_SERVICE_ID,
         apis: [
           {
@@ -35,14 +33,14 @@ module.exports = {
                 'updatedAt',
               ].join(','),
               filters: exists('title'),
-            }
+            },
           },
           {
             endpoint: 'gatsbyobject',
-            format: 'object'
-          }
-        ]
+            format: 'object',
+          },
+        ],
       },
-    }
+    },
   ],
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-source-microcms",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "description": "Source plugin for Gatsby from microCMS.",
   "main": "gatsby-node.js",
   "license": "MIT",
diff --git a/src/__tests__/fetch.js b/src/__tests__/fetch.js
@@ -5,9 +5,9 @@ const apiKey = 'key';
 const baseUrl = 'https://example.com';
 const nockBase = nock(baseUrl, {
   reqheaders: {
-    'x-api-key': apiKey,
+    'x-microcms-api-key': apiKey,
   },
-}).matchHeader('x-api-key', apiKey);
+}).matchHeader('x-microcms-api-key', apiKey);
 
 describe('fetch', () => {
   test('default', async () => {
diff --git a/src/fetch.js b/src/fetch.js
@@ -7,7 +7,7 @@ const fetch = require('node-fetch');
  * @param {string} param.apiKey
  * @param {object} param.query
  */
-module.exports = function fetchData(url, { apiKey, globalDraftKey, query }) {
+module.exports = function fetchData(url, { apiKey, query }) {
   // remove empty string or undefined or null query
   for (let q in query) {
     if (!query[q]) {
@@ -20,8 +20,7 @@ module.exports = function fetchData(url, { apiKey, globalDraftKey, query }) {
 
   return fetch(reqUrl, {
     headers: {
-      'x-api-key': apiKey,
-      'x-global-draft-key': globalDraftKey,
+      'x-microcms-api-key': apiKey,
     },
   }).then(async res => {
     const body = await res.json();
diff --git a/src/pluginOptions.js b/src/pluginOptions.js
@@ -17,25 +17,29 @@ const optionsSchema = Joi.object().keys({
   apiKey: Joi.string()
     .required()
     .empty(),
-  globalDraftKey: Joi.string(),
   serviceId: Joi.string()
     .required()
     .empty(),
-  apis: Joi.array().items(Joi.object({
-    endpoint: Joi.string().required().empty(),
-    type: Joi.string(),
-    format: Joi.string().pattern(/^(list|object)$/),
-    query: Joi.object({
-      draftKey: Joi.string(),
-      fields: Joi.string(),
-      limit: Joi.number().integer(),
-      offset: Joi.number().integer(),
-      filters: Joi.string(),
-      depth: Joi.number()
-        .integer()
-        .max(3),
-    }),
-  }))
+  apis: Joi.array()
+    .items(
+      Joi.object({
+        endpoint: Joi.string()
+          .required()
+          .empty(),
+        type: Joi.string(),
+        format: Joi.string().pattern(/^(list|object)$/),
+        query: Joi.object({
+          draftKey: Joi.string(),
+          fields: Joi.string(),
+          limit: Joi.number().integer(),
+          offset: Joi.number().integer(),
+          filters: Joi.string(),
+          depth: Joi.number()
+            .integer()
+            .max(3),
+        }),
+      })
+    )
     .required()
     .empty(),
   version: Joi.string(),
diff --git a/src/sourceNodes.js b/src/sourceNodes.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "gatsby-source-microcms",`
`3`		`- "version": "1.2.1",`
	`3`	`+ "version": "2.0.0",`
`4`	`4`	`"description": "Source plugin for Gatsby from microCMS.",`
`5`	`5`	`"main": "gatsby-node.js",`
`6`	`6`	`"license": "MIT",`