Merge pull request #97 from microcmsio/add-draft-to-patch

updateのリクエストにisDraft追加

Author: wato787

README.md

@@ -319,8 +319,6 @@ client
       title: 'title',
       body: 'body',
     },
-    // Available with microCMS paid plans
-    // https://microcms.io/pricing
     isDraft: true,
   })
   .then((res) => console.log(res.id))
@@ -340,8 +338,6 @@ client
       title: 'title',
       body: 'body',
     },
-    // Available with microCMS paid plans
-    // https://microcms.io/pricing
     isDraft: true,
   })
   .then((res) => console.log(res.id))
@@ -365,6 +361,24 @@ client
   .catch((err) => console.error(err));
 ```
 
+#### Update content as draft
+
+By specifying the `isDraft` property, it is possible to update the content as a draft.
+
+```javascript
+client
+  .update({
+    endpoint: 'endpoint',
+    contentId: 'contentId',
+    content: {
+      title: 'title',
+    },
+    isDraft: true,
+  })
+  .then((res) => console.log(res.id))
+  .catch((err) => console.error(err));
+```
+
 #### Update object format content
 
 When updating object content, use the `update` method without specifying a `contentId` property.

README_jp.md

@@ -319,8 +319,6 @@ client
       title: 'タイトル',
       body: '本文',
     },
-    // 有料プランから利用可能
-    // https://microcms.io/pricing
     isDraft: true,
   })
   .then((res) => console.log(res.id))
@@ -340,8 +338,6 @@ client
       title: 'タイトル',
       body: '本文',
     },
-    // 有料プランから利用可能
-    // https://microcms.io/pricing
     isDraft: true,
   })
   .then((res) => console.log(res.id))
@@ -365,6 +361,24 @@ client
   .catch((err) => console.error(err));
 ```
 
+#### コンテンツの下書き更新
+
+`isDraft` プロパティを指定することで、コンテンツを下書き状態で更新することができます。
+
+```javascript
+client
+  .update({
+    endpoint: 'endpoint',
+    contentId: 'contentId',
+    content: {
+      title: 'タイトル',
+    },
+    isDraft: true,
+  })
+  .then((res) => console.log(res.id))
+  .catch((err) => console.error(err));
+```
+
 #### オブジェクト形式のコンテンツの編集
 
 APIの型がオブジェクト形式のコンテンツを編集する場合は、`contentId`プロパティを使用せずに、エンドポイントのみを指定します。

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "microcms-js-sdk",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "JavaScript SDK Client for microCMS.",
   "engines": {
     "node": ">=18.0.0"

package.json

@@ -358,12 +358,14 @@ export const createClient = ({
     endpoint,
     contentId,
     content,
+    isDraft = false,
     customRequestInit,
   }: UpdateRequest<T>): Promise<WriteApiRequestResult> => {
     if (!endpoint) {
       return Promise.reject(new Error('endpoint is required'));
     }
 
+    const queries: MakeRequest['queries'] = isDraft ? { status: 'draft' } : {};
     const requestInit: MakeRequest['requestInit'] = {
       ...customRequestInit,
       method: 'PATCH',
@@ -376,6 +378,7 @@ export const createClient = ({
     return makeRequest({
       endpoint,
       contentId,
+      queries,
       requestInit,
     });
   };

src/createClient.ts

@@ -159,6 +159,7 @@ export interface UpdateRequest<T> {
   endpoint: string;
   contentId?: string;
   content: Partial<T>;
+  isDraft?: boolean;
   customRequestInit?: CustomRequestInit;
 }
 

src/types.ts

@@ -131,13 +131,17 @@ describe('update', () => {
   beforeEach(() => {
     server.use(
       http.patch(`${testBaseUrl}/list-type/foo`, async ({ request }) => {
+        const url = new URL(request.url);
+        const statusParams = url.searchParams.get('status');
         const body = await request.json();
-        patchListApiMockFn(body);
+        patchListApiMockFn(statusParams, body);
         return HttpResponse.json({ id: 'foo' }, { status: 200 });
       }),
       http.patch(`${testBaseUrl}/object-type`, async ({ request }) => {
+        const url = new URL(request.url);
+        const statusParams = url.searchParams.get('status');
         const body = await request.json();
-        patchObjectApiMockFn(body);
+        patchObjectApiMockFn(statusParams, body);
         return HttpResponse.json({ id: 'foo' }, { status: 200 });
       }),
     );
@@ -156,13 +160,32 @@ describe('update', () => {
       },
     });
     expect(data).toEqual({ id: 'foo' });
-    // Confirm PUT api was called
+    // Confirm PATCH api was called
+    expect(patchListApiMockFn).toHaveBeenCalledTimes(1);
+    // Confirm that body is specified.
+    expect(patchListApiMockFn).toHaveBeenCalledWith(null, {
+      title: 'title',
+    });
+  });
+
+  test('Draft list format content can be updated', async () => {
+    const data = await client.update<ContentType>({
+      endpoint: 'list-type',
+      contentId: 'foo',
+      content: {
+        title: 'title',
+      },
+      isDraft: true,
+    });
+    expect(data).toEqual({ id: 'foo' });
+    // Confirm PATCH api was called
     expect(patchListApiMockFn).toHaveBeenCalledTimes(1);
     // Confirm that body is specified.
-    expect(patchListApiMockFn).toHaveBeenCalledWith({
+    expect(patchListApiMockFn).toHaveBeenCalledWith('draft', {
       title: 'title',
     });
   });
+
   test('Object type content can be updated', async () => {
     const data = await client.update<ContentType>({
       endpoint: 'object-type',
@@ -171,10 +194,27 @@ describe('update', () => {
       },
     });
     expect(data).toEqual({ id: 'foo' });
-    // Confirm PUT api was called
+    // Confirm PATCH api was called
+    expect(patchObjectApiMockFn).toHaveBeenCalledTimes(1);
+    // Confirm that body is specified.
+    expect(patchObjectApiMockFn).toHaveBeenCalledWith(null, {
+      title: 'title',
+    });
+  });
+
+  test('Draft object type content can be updated', async () => {
+    const data = await client.update<ContentType>({
+      endpoint: 'object-type',
+      content: {
+        title: 'title',
+      },
+      isDraft: true,
+    });
+    expect(data).toEqual({ id: 'foo' });
+    // Confirm PATCH api was called
     expect(patchObjectApiMockFn).toHaveBeenCalledTimes(1);
     // Confirm that body is specified.
-    expect(patchObjectApiMockFn).toHaveBeenCalledWith({
+    expect(patchObjectApiMockFn).toHaveBeenCalledWith('draft', {
       title: 'title',
     });
   });