feat: target field

Author: dc7290

src/createClient.ts

@@ -222,6 +222,7 @@ export const createClient = ({
 
   const getAllContentIds = async ({
     endpoint,
+    target,
     draftKey,
     filters,
     orders,
@@ -233,7 +234,7 @@ export const createClient = ({
       filters,
       orders,
       limit,
-      fields: 'id',
+      fields: target ?? 'id',
     };
 
     const { totalCount } = await makeRequest({
@@ -247,15 +248,24 @@ export const createClient = ({
 
     const sleep = (ms: number) =>
       new Promise((resolve) => setTimeout(resolve, ms));
+    const isStringArray = (arr: unknown[]): arr is string[] =>
+      arr.every((item) => typeof item === 'string');
 
     while (contentIds.length < totalCount) {
       const { contents } = (await makeRequest({
         endpoint,
         queries: { ...defaultQueries, offset },
         requestInit: customRequestInit,
-      })) as MicroCMSListResponse<Record<string, never>>;
+      })) as MicroCMSListResponse<Record<string, unknown>>;
+
+      const ids = contents.map((content) => content[target ?? 'id']);
+
+      if (!isStringArray(ids)) {
+        throw new Error(
+          'The value of the field specified by `target` is not a string.',
+        );
+      }
 
-      const ids = contents.map((content) => content.id);
       contentIds = [...contentIds, ...ids];
 
       offset += limit;

src/types.ts

@@ -117,6 +117,12 @@ export interface GetObjectRequest {
 
 export interface GetAllContentIdsRequest {
   endpoint: string;
+  /**
+   * @type {string} target
+   * @example 'url'
+   * If you are using a URL other than the content ID, for example, you can specify that value in the `target` field.
+   */
+  target?: string;
   draftKey?: string;
   filters?: string;
   orders?: string;

tests/getAllContentIds.test.ts

@@ -20,7 +20,7 @@ describe('getAllContentIds', () => {
           ctx.status(200),
           ctx.json({
             totalCount: 100,
-          })
+          }),
         );
       }),
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
@@ -30,9 +30,9 @@ describe('getAllContentIds', () => {
             contents: Array(100)
               .fill(null)
               .map((_, index) => ({ id: `id${index}` })),
-          })
+          }),
         );
-      })
+      }),
     );
 
     const result = await client.getAllContentIds({
@@ -51,7 +51,7 @@ describe('getAllContentIds', () => {
           ctx.status(200),
           ctx.json({
             totalCount: 250,
-          })
+          }),
         );
       }),
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
@@ -61,7 +61,7 @@ describe('getAllContentIds', () => {
             contents: Array(100)
               .fill(null)
               .map((_, index) => ({ id: `id${index}` })),
-          })
+          }),
         );
       }),
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
@@ -71,7 +71,7 @@ describe('getAllContentIds', () => {
             contents: Array(100)
               .fill(null)
               .map((_, index) => ({ id: `id${index + 100}` })),
-          })
+          }),
         );
       }),
       rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
@@ -81,9 +81,9 @@ describe('getAllContentIds', () => {
             contents: Array(50)
               .fill(null)
               .map((_, index) => ({ id: `id${index + 200}` })),
-          })
+          }),
         );
-      })
+      }),
     );
 
     const result = await client.getAllContentIds({
@@ -94,4 +94,68 @@ describe('getAllContentIds', () => {
     expect(result).toContain('id0');
     expect(result).toContain('id249');
   });
+
+  test('should fetch all content ids with target field', async () => {
+    server.use(
+      rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
+        return res.once(
+          ctx.status(200),
+          ctx.json({
+            totalCount: 100,
+          }),
+        );
+      }),
+      rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
+        return res.once(
+          ctx.status(200),
+          ctx.json({
+            contents: Array(100)
+              .fill(null)
+              .map((_, index) => ({ url: `id${index}` })),
+          }),
+        );
+      }),
+    );
+
+    const result = await client.getAllContentIds({
+      endpoint: 'getAllContentIds-list-type',
+      target: 'url',
+    });
+
+    expect(result).toHaveLength(100);
+    expect(result).toContain('id0');
+    expect(result).toContain('id99');
+  });
+
+  test('should throw error when target field is not string', async () => {
+    server.use(
+      rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
+        return res.once(
+          ctx.status(200),
+          ctx.json({
+            totalCount: 100,
+          }),
+        );
+      }),
+      rest.get(`${testBaseUrl}/getAllContentIds-list-type`, (_, res, ctx) => {
+        return res.once(
+          ctx.status(200),
+          ctx.json({
+            contents: Array(100)
+              .fill(null)
+              .map(() => ({ image: { url: 'url', width: 100, height: 100 } })),
+          }),
+        );
+      }),
+    );
+
+    expect(() =>
+      client.getAllContentIds({
+        endpoint: 'getAllContentIds-list-type',
+        target: 'image',
+      }),
+    ).toThrowError(
+      'The value of the field specified by `target` is not a string.',
+    );
+  });
 });