Merge pull request #65 from microcmsio/fix/get-all-content-ids

getAllContentIdsについてフィールド名とdepthの扱いを修正

Author: dc7290

README.md

@@ -110,7 +110,7 @@ client
 
 This function can be used to retrieve all content IDs only.  
 Since `filters` and `draftKey` can also be specified, it is possible to retrieve only the content IDs for a specific category, or to include content from a specific draft.  \
-The `target` property can also be used to address cases where the value of a field other than content ID is used in a URL, etc.
+The `alternateField` property can also be used to address cases where the value of a field other than content ID is used in a URL, etc.
 
 ```javascript
 client
@@ -138,11 +138,11 @@ client
   .then((res) => console.log(res))
   .catch((err) => console.error(err));
 
-// Get all content ids with target
+// Get all content ids with alternateField
 client
   .getAllContentIds({
     endpoint: 'endpoint',
-    target: 'url',
+    alternateField: 'url',
   })
   .then((res) => console.log(res))
   .catch((err) => console.error(err));

src/createClient.ts

@@ -222,7 +222,7 @@ export const createClient = ({
 
   const getAllContentIds = async ({
     endpoint,
-    target,
+    alternateField,
     draftKey,
     filters,
     orders,
@@ -234,7 +234,8 @@ export const createClient = ({
       filters,
       orders,
       limit,
-      fields: target ?? 'id',
+      fields: alternateField ?? 'id',
+      depth: 0,
     };
 
     const { totalCount } = await makeRequest({
@@ -258,11 +259,11 @@ export const createClient = ({
         requestInit: customRequestInit,
       })) as MicroCMSListResponse<Record<string, unknown>>;
 
-      const ids = contents.map((content) => content[target ?? 'id']);
+      const ids = contents.map((content) => content[alternateField ?? 'id']);
 
       if (!isStringArray(ids)) {
         throw new Error(
-          'The value of the field specified by `target` is not a string.',
+          'The value of the field specified by `alternateField` is not a string.',
         );
       }
 

src/types.ts

@@ -10,7 +10,7 @@ export interface MicroCMSClient {
   retry?: boolean;
 }
 
-type depthNumber = 1 | 2 | 3;
+type depthNumber = 0 | 1 | 2 | 3;
 
 /**
  * microCMS queries
@@ -118,11 +118,11 @@ export interface GetObjectRequest {
 export interface GetAllContentIdsRequest {
   endpoint: string;
   /**
-   * @type {string} target
+   * @type {string} alternateField
    * @example 'url'
-   * If you are using a URL other than the content ID, for example, you can specify that value in the `target` field.
+   * If you are using a URL other than the content ID, for example, you can specify that value in the `alternateField` field.
    */
-  target?: string;
+  alternateField?: string;
   draftKey?: string;
   filters?: string;
   orders?: string;

tests/getAllContentIds.test.ts

@@ -95,7 +95,7 @@ describe('getAllContentIds', () => {
     expect(result).toContain('id249');
   });
 
-  test('should fetch all content ids with target field', async () => {
+  test('should fetch all content ids with alternateField field', async () => {
     server.use(
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
         return res.once(
@@ -119,15 +119,15 @@ describe('getAllContentIds', () => {
 
     const result = await client.getAllContentIds({
       endpoint: 'getAllContentIds-list-type',
-      target: 'url',
+      alternateField: 'url',
     });
 
     expect(result).toHaveLength(100);
     expect(result).toContain('id0');
     expect(result).toContain('id99');
   });
 
-  test('should throw error when target field is not string', async () => {
+  test('should throw error when alternateField field is not string', async () => {
     server.use(
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
         return res.once(
@@ -152,10 +152,10 @@ describe('getAllContentIds', () => {
     await expect(
       client.getAllContentIds({
         endpoint: 'getAllContentIds-list-type',
-        target: 'image',
+        alternateField: 'image',
       }),
     ).rejects.toThrowError(
-      'The value of the field specified by `target` is not a string.',
+      'The value of the field specified by `alternateField` is not a string.',
     );
   });
 });