firefish/packages/backend/src/server/api/endpoints/announcements.ts

105 lines
2.1 KiB
TypeScript
Raw Normal View History

2023-01-13 05:40:33 +01:00
import { Announcements, AnnouncementReads } from "@/models/index.js";
import define from "../define.js";
import { makePaginationQuery } from "../common/make-pagination-query.js";
export const meta = {
2023-01-13 05:40:33 +01:00
tags: ["meta"],
refactor: APIエンドポイントファイルの定義を良い感じにする (#8154) * Fix API Schema Error * Delete SimpleSchema/SimpleObj and Move schemas to dedicated files * Userのスキーマを分割してみる * define packMany type * add , * Ensure enum schema and Make "as const" put once * test? * Revert "test?" This reverts commit 97dc9bfa70851bfb7d1cf38e883f8df20fb78b79. * Revert "Fix API Schema Error" This reverts commit 21b6176d974ed8e3eb73723ad21a105c5d297323. * :v: * clean up * test? * wip * wip * better schema def * :v: * fix * add minLength property * wip * wip * wip * anyOf/oneOf/allOfに対応? ~ relation.ts * refactor! * Define MinimumSchema * wip * wip * anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正 * anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正 * Update packages/backend/src/misc/schema.ts Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com> * fix * array oneOfをより正確な型に * array oneOfをより正確な型に * wip * :v: * なんかもういろいろ * remove * very good schema * api schema * wip * refactor: awaitAllの型定義を変えてみる * fix * specify types in awaitAll * specify types in awaitAll * :v: * wip * ... * :v: * AllowDateはやめておく * 不必要なoptional: false, nullable: falseを廃止 * Packedが展開されないように * 続packed * wip * define note type * wip * UserDetailedをMeDetailedかUserDetailedNotMeかを区別できるように * wip * wip * wip specify user type of other schemas * ok * convertSchemaToOpenApiSchemaを改修 * convertSchemaToOpenApiSchemaを改修 * Fix * fix * :v: * wip * 分割代入ではなくallOfで定義するように Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com>
2022-01-18 14:27:10 +01:00
requireCredential: false,
requireCredentialPrivateMode: true,
res: {
2023-01-13 05:40:33 +01:00
type: "array",
optional: false,
nullable: false,
items: {
2023-01-13 05:40:33 +01:00
type: "object",
optional: false,
nullable: false,
properties: {
id: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: false,
format: "id",
example: "xxxxxxxxxx",
},
createdAt: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: false,
format: "date-time",
},
updatedAt: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: true,
format: "date-time",
},
text: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: false,
},
title: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: false,
},
imageUrl: {
2023-01-13 05:40:33 +01:00
type: "string",
optional: false,
nullable: true,
},
isRead: {
2023-01-13 05:40:33 +01:00
type: "boolean",
optional: true,
nullable: false,
2021-12-09 15:58:30 +01:00
},
},
},
},
refactor: APIエンドポイントファイルの定義を良い感じにする (#8154) * Fix API Schema Error * Delete SimpleSchema/SimpleObj and Move schemas to dedicated files * Userのスキーマを分割してみる * define packMany type * add , * Ensure enum schema and Make "as const" put once * test? * Revert "test?" This reverts commit 97dc9bfa70851bfb7d1cf38e883f8df20fb78b79. * Revert "Fix API Schema Error" This reverts commit 21b6176d974ed8e3eb73723ad21a105c5d297323. * :v: * clean up * test? * wip * wip * better schema def * :v: * fix * add minLength property * wip * wip * wip * anyOf/oneOf/allOfに対応? ~ relation.ts * refactor! * Define MinimumSchema * wip * wip * anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正 * anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正 * Update packages/backend/src/misc/schema.ts Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com> * fix * array oneOfをより正確な型に * array oneOfをより正確な型に * wip * :v: * なんかもういろいろ * remove * very good schema * api schema * wip * refactor: awaitAllの型定義を変えてみる * fix * specify types in awaitAll * specify types in awaitAll * :v: * wip * ... * :v: * AllowDateはやめておく * 不必要なoptional: false, nullable: falseを廃止 * Packedが展開されないように * 続packed * wip * define note type * wip * UserDetailedをMeDetailedかUserDetailedNotMeかを区別できるように * wip * wip * wip specify user type of other schemas * ok * convertSchemaToOpenApiSchemaを改修 * convertSchemaToOpenApiSchemaを改修 * Fix * fix * :v: * wip * 分割代入ではなくallOfで定義するように Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com>
2022-01-18 14:27:10 +01:00
} as const;
export const paramDef = {
2023-01-13 05:40:33 +01:00
type: "object",
properties: {
2023-01-13 05:40:33 +01:00
limit: { type: "integer", minimum: 1, maximum: 100, default: 10 },
withUnreads: { type: "boolean", default: false },
sinceId: { type: "string", format: "misskey:id" },
untilId: { type: "string", format: "misskey:id" },
},
required: [],
} as const;
2023-01-13 05:54:33 +01:00
export default define(meta, paramDef, async (ps, user) => {
2023-01-13 05:40:33 +01:00
const query = makePaginationQuery(
Announcements.createQueryBuilder("announcement"),
ps.sinceId,
ps.untilId,
);
const announcements = await query.take(ps.limit).getMany();
if (user) {
2023-01-13 05:40:33 +01:00
const reads = (
await AnnouncementReads.findBy({
userId: user.id,
})
).map((x) => x.announcementId);
for (const announcement of announcements) {
(announcement as any).isRead = reads.includes(announcement.id);
}
}
2023-01-13 05:40:33 +01:00
return (
ps.withUnreads ? announcements.filter((a: any) => !a.isRead) : announcements
).map((a) => ({
2022-02-03 13:09:07 +01:00
...a,
createdAt: a.createdAt.toISOString(),
updatedAt: a.updatedAt?.toISOString() ?? null,
}));
});