Merge pull request #23 from microcmsio/fix/replace-x-microcms-api-key

新形式APIキー(X-MICROCMS-API-KEY)対応

Author: hiro08gh

README.md

@@ -34,7 +34,6 @@ import { createClient } from 'microcms-js-sdk'; //ES6
 const client = createClient({
   serviceDomain: "YOUR_DOMAIN", // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
   apiKey: "YOUR_API_KEY",
-  globalDraftKey: "YOUR_GLOBAL_DRAFT_KEY", // If need 
 });
 ```
 
@@ -48,7 +47,6 @@ const { createClient } = microcms;
 const client = createClient({
   serviceDomain: "YOUR_DOMAIN", // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
   apiKey: "YOUR_API_KEY",
-  globalDraftKey: "YOUR_GLOBAL_DRAFT_KEY", // If need 
 });
 </script>
 ```
@@ -60,7 +58,6 @@ client
   .get({
     endpoint: 'endpoint',
     queries: { limit: 20, filters: 'createdAt[greater_than]2021' },
-    useGlobalDraftKey: false, // This is an option if your have set the globalDraftKey. Default value true.
   })
   .then((res) => console.log(res))
   .catch((err) => console.log(err));

src/createClient.ts

@@ -23,7 +23,7 @@ const API_VERSION = 'v1';
 /**
  * Initialize SDK Client
  */
-export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMSClient) => {
+export const createClient = ({ serviceDomain, apiKey }: MicroCMSClient) => {
   if (!serviceDomain || !apiKey) {
     throw new Error('parameter is required (check serviceDomain and apiKey)');
   }
@@ -44,17 +44,13 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
     endpoint,
     contentId,
     queries = {},
-    useGlobalDraftKey = true,
   }: MakeRequest): Promise<T> => {
     const queryString = parseQuery(queries);
 
     const baseHeaders = {
-      headers: { 'X-API-KEY': apiKey },
+      headers: { 'X-MICROCMS-API-KEY': apiKey },
     };
 
-    if (globalDraftKey && useGlobalDraftKey) {
-      Object.assign(baseHeaders.headers, { 'X-GLOBAL-DRAFT-KEY': globalDraftKey });
-    }
 
     const url = `${baseUrl}/${endpoint}${contentId ? `/${contentId}` : ''}${
       queryString ? `?${queryString}` : ''
@@ -90,12 +86,11 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
     endpoint,
     contentId,
     queries = {},
-    useGlobalDraftKey,
   }: GetRequest): Promise<T> => {
     if (!endpoint) {
       return Promise.reject(new Error('endpoint is required'));
     }
-    return await makeRequest<T>({ endpoint, contentId, queries, useGlobalDraftKey });
+    return await makeRequest<T>({ endpoint, contentId, queries });
   };
 
   /**
@@ -104,12 +99,11 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
   const getList = async <T = any>({
     endpoint,
     queries = {},
-    useGlobalDraftKey,
   }: GetListRequest): Promise<MicroCMSListResponse<T>> => {
     if (!endpoint) {
       return Promise.reject(new Error('endpoint is required'));
     }
-    return await makeRequest<MicroCMSListResponse<T>>({ endpoint, queries, useGlobalDraftKey });
+    return await makeRequest<MicroCMSListResponse<T>>({ endpoint, queries });
   };
 
   /**
@@ -119,7 +113,6 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
     endpoint,
     contentId,
     queries = {},
-    useGlobalDraftKey,
   }: GetListDetailRequest): Promise<T & MicroCMSListContent> => {
     if (!endpoint) {
       return Promise.reject(new Error('endpoint is required'));
@@ -128,7 +121,6 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
       endpoint,
       contentId,
       queries,
-      useGlobalDraftKey,
     });
   };
 
@@ -138,15 +130,13 @@ export const createClient = ({ serviceDomain, apiKey, globalDraftKey }: MicroCMS
   const getObject = async <T = any>({
     endpoint,
     queries = {},
-    useGlobalDraftKey,
   }: GetObjectRequest): Promise<T & MicroCMSObjectContent> => {
     if (!endpoint) {
       return Promise.reject(new Error('endpoint is required'));
     }
     return await makeRequest<T & MicroCMSObjectContent>({
       endpoint,
       queries,
-      useGlobalDraftKey,
     });
   };
 

src/types.ts

@@ -4,7 +4,6 @@
 export interface MicroCMSClient {
   serviceDomain: string;
   apiKey: string;
-  globalDraftKey?: string;
 }
 
 type depthNumber = 1 | 2 | 3;
@@ -77,31 +76,26 @@ export interface MakeRequest {
   endpoint: string;
   contentId?: string;
   queries?: MicroCMSQueries;
-  useGlobalDraftKey?: boolean;
 }
 
 export interface GetRequest {
   endpoint: string;
   contentId?: string;
   queries?: MicroCMSQueries;
-  useGlobalDraftKey?: boolean;
 }
 
 export interface GetListDetailRequest {
   endpoint: string;
   contentId: string;
   queries?: MicroCMSQueries;
-  useGlobalDraftKey?: boolean;
 }
 
 export interface GetListRequest {
   endpoint: string;
   queries?: MicroCMSQueries;
-  useGlobalDraftKey?: boolean;
 }
 
 export interface GetObjectRequest {
   endpoint: string;
   queries?: MicroCMSQueries;
-  useGlobalDraftKey?: boolean;
 }