fix(backend): クリップ一覧APIをページネーションに対応させる (#16434)

* fix(backend): クリップ一覧APIをページネーションに対応させる

* Update Changelog

CHANGELOG.md

@@ -62,6 +62,7 @@
 - Enhance: ノートの削除処理の効率化
 - Enhance: 全体的なパフォーマンスの向上
 - Enhance: 依存ソフトウェアの更新
+- Enhance: `clips/list` APIがページネーションに対応しました
 - Fix: SystemWebhook設定でsecretを空に出来ない問題を修正
 
 

packages/backend/src/server/api/endpoints/clips/list.ts

@@ -5,6 +5,7 @@
 
 import { Inject, Injectable } from '@nestjs/common';
 import { Endpoint } from '@/server/api/endpoint-base.js';
+import { QueryService } from '@/core/QueryService.js';
 import type { ClipsRepository } from '@/models/_.js';
 import { ClipEntityService } from '@/core/entities/ClipEntityService.js';
 import { DI } from '@/di-symbols.js';
@@ -29,7 +30,13 @@ export const meta = {
 
 export const paramDef = {
 	type: 'object',
-	properties: {},
+	properties: {
+		limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+		sinceId: { type: 'string', format: 'misskey:id' },
+		untilId: { type: 'string', format: 'misskey:id' },
+		sinceDate: { type: 'integer' },
+		untilDate: { type: 'integer' },
+	},
 	required: [],
 } as const;
 
@@ -39,12 +46,14 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
 		@Inject(DI.clipsRepository)
 		private clipsRepository: ClipsRepository,
 
+		private queryService: QueryService,
 		private clipEntityService: ClipEntityService,
 	) {
 		super(meta, paramDef, async (ps, me) => {
-			const clips = await this.clipsRepository.findBy({
-				userId: me.id,
-			});
+			const query = this.queryService.makePaginationQuery(this.clipsRepository.createQueryBuilder('clip'), ps.sinceId, ps.untilId, ps.sinceDate, ps.untilDate)
+				.andWhere('clip.userId = :userId', { userId: me.id });
+
+			const clips = await query.limit(ps.limit).getMany();
 
 			return await this.clipEntityService.packMany(clips, me);
 		});

packages/misskey-js/etc/misskey-js.api.md

@@ -1196,6 +1196,9 @@ type ClipsDeleteRequest = operations['clips___delete']['requestBody']['content']
 // @public (undocumented)
 type ClipsFavoriteRequest = operations['clips___favorite']['requestBody']['content']['application/json'];
 
+// @public (undocumented)
+type ClipsListRequest = operations['clips___list']['requestBody']['content']['application/json'];
+
 // @public (undocumented)
 type ClipsListResponse = operations['clips___list']['responses']['200']['content']['application/json'];
 
@@ -1741,6 +1744,7 @@ declare namespace entities {
         ClipsCreateResponse,
         ClipsDeleteRequest,
         ClipsFavoriteRequest,
+        ClipsListRequest,
         ClipsListResponse,
         ClipsMyFavoritesResponse,
         ClipsNotesRequest,

packages/misskey-js/src/autogen/endpoint.ts

@@ -264,6 +264,7 @@ import type {
 	ClipsCreateResponse,
 	ClipsDeleteRequest,
 	ClipsFavoriteRequest,
+	ClipsListRequest,
 	ClipsListResponse,
 	ClipsMyFavoritesResponse,
 	ClipsNotesRequest,
@@ -830,7 +831,7 @@ export type Endpoints = {
 	'clips/create': { req: ClipsCreateRequest; res: ClipsCreateResponse };
 	'clips/delete': { req: ClipsDeleteRequest; res: EmptyResponse };
 	'clips/favorite': { req: ClipsFavoriteRequest; res: EmptyResponse };
-	'clips/list': { req: EmptyRequest; res: ClipsListResponse };
+	'clips/list': { req: ClipsListRequest; res: ClipsListResponse };
 	'clips/my-favorites': { req: EmptyRequest; res: ClipsMyFavoritesResponse };
 	'clips/notes': { req: ClipsNotesRequest; res: ClipsNotesResponse };
 	'clips/remove-note': { req: ClipsRemoveNoteRequest; res: EmptyResponse };

packages/misskey-js/src/autogen/entities.ts

@@ -267,6 +267,7 @@ export type ClipsCreateRequest = operations['clips___create']['requestBody']['co
 export type ClipsCreateResponse = operations['clips___create']['responses']['200']['content']['application/json'];
 export type ClipsDeleteRequest = operations['clips___delete']['requestBody']['content']['application/json'];
 export type ClipsFavoriteRequest = operations['clips___favorite']['requestBody']['content']['application/json'];
+export type ClipsListRequest = operations['clips___list']['requestBody']['content']['application/json'];
 export type ClipsListResponse = operations['clips___list']['responses']['200']['content']['application/json'];
 export type ClipsMyFavoritesResponse = operations['clips___my-favorites']['responses']['200']['content']['application/json'];
 export type ClipsNotesRequest = operations['clips___notes']['requestBody']['content']['application/json'];

packages/misskey-js/src/autogen/types.ts

@@ -18263,6 +18263,20 @@ export interface operations {
         };
     };
     clips___list: {
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @default 10 */
+                    limit?: number;
+                    /** Format: misskey:id */
+                    sinceId?: string;
+                    /** Format: misskey:id */
+                    untilId?: string;
+                    sinceDate?: number;
+                    untilDate?: number;
+                };
+            };
+        };
         responses: {
             /** @description OK (with results) */
             200: {