feat: new api to create subject (#719)

Author: trim21

.eslintrc.cjs

@@ -49,6 +49,7 @@ module.exports = {
       ],
       plugins: ['@typescript-eslint', 'tsdoc'],
       rules: {
+        '@typescript-eslint/restrict-template-expressions': 'off',
         'unicorn/import-style': 'off',
         'rulesdir/no-relative-parent-import': 'error',
         'unused-imports/no-unused-imports': 'error',

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/common"]
+	path = vendor/common
+	url = https://github.com/Bangumi/common

lib/subject/type.ts

@@ -5,3 +5,5 @@ export enum SubjectType {
   Game = 4, // 游戏
   Real = 6, // 三次元
 }
+
+export const SubjectTypeValues = new Set([1, 2, 3, 4, 6]);

package.json

@@ -12,6 +12,7 @@
   "scripts": {
     "format": "prettier --list-different -w ./",
     "tsc": "tsc",
+    "build-common": "node scripts/build-common.cjs",
     "lint": "eslint --ext ts,cjs,js ./",
     "start": "nodemon ./bin/main.ts",
     "test": "vitest --run",
@@ -65,7 +66,8 @@
     "socket.io": "^4.7.5",
     "socks-proxy-agent": "^8.0.4",
     "tsx": "^4.19.0",
-    "typeorm": "^0.3.20"
+    "typeorm": "^0.3.20",
+    "yaml": "^2.5.1"
   },
   "devDependencies": {
     "@shopify/prettier-plugin-liquid": "^1.5.0",

pnpm-lock.yaml

@@ -1,13 +1,20 @@
+import { parseToMap } from '@bgm38/wiki';
 import type { Static } from '@sinclair/typebox';
 import { Type as t } from '@sinclair/typebox';
+import { StatusCodes } from 'http-status-codes';
+import { DateTime } from 'luxon';
+import type { ResultSetHeader } from 'mysql2';
 
 import { NotAllowedError } from '@app/lib/auth/index.ts';
 import { BadRequestError, NotFoundError } from '@app/lib/error.ts';
 import { Security, Tag } from '@app/lib/openapi/index.ts';
-import { SubjectRevRepo } from '@app/lib/orm/index.ts';
+import * as entity from '@app/lib/orm/entity';
+import { AppDataSource, SubjectRevRepo } from '@app/lib/orm/index.ts';
 import * as orm from '@app/lib/orm/index.ts';
 import * as Subject from '@app/lib/subject/index.ts';
-import { InvalidWikiSyntaxError, platforms } from '@app/lib/subject/index.ts';
+import { InvalidWikiSyntaxError, platforms, SubjectType } from '@app/lib/subject/index.ts';
+import PlatformConfig from '@app/lib/subject/platform.ts';
+import { SubjectTypeValues } from '@app/lib/subject/type.ts';
 import * as res from '@app/lib/types/res.ts';
 import { formatErrors } from '@app/lib/types/res.ts';
 import { requireLogin } from '@app/routes/hooks/pre-handler.ts';
@@ -48,6 +55,21 @@ const exampleSubjectEdit = {
 https://bgm.tv/group/topic/366812#post_1923517`,
 };
 
+export type ISubjectNew = Static<typeof SubjectNew>;
+export const SubjectNew = t.Object(
+  {
+    name: t.String({ minLength: 1 }),
+    type: t.Enum(SubjectType),
+    platform: t.Integer(),
+    infobox: t.String({ minLength: 1 }),
+    nsfw: t.Boolean(),
+    summary: t.String(),
+  },
+  {
+    $id: 'SubjectNew',
+  },
+);
+
 export type ISubjectEdit = Static<typeof SubjectEdit>;
 export const SubjectEdit = t.Object(
   {
@@ -163,6 +185,125 @@ export async function setup(app: App) {
     },
   );
 
+  app.addSchema(SubjectNew);
+
+  app.post(
+    '/subjects',
+    {
+      schema: {
+        tags: [Tag.Wiki],
+        operationId: 'createNewSubject',
+        description: '创建新条目',
+        security: [{ [Security.CookiesSession]: [], [Security.HTTPBearer]: [] }],
+        body: SubjectNew,
+        response: {
+          200: t.Object({ subjectID: t.Number() }),
+          [StatusCodes.BAD_REQUEST]: t.Ref(res.Error, {
+            'x-examples': formatErrors(InvalidWikiSyntaxError()),
+          }),
+          401: t.Ref(res.Error, {}),
+        },
+      },
+    },
+    async ({ auth, body }) => {
+      if (!auth.permission.subject_edit) {
+        throw new NotAllowedError('edit subject');
+      }
+
+      if (!SubjectTypeValues.has(body.type)) {
+        throw new BadRequestError(`条目类型错误`);
+      }
+
+      if (!(body.platform in PlatformConfig[body.type])) {
+        throw new BadRequestError(`条目分类错误`);
+      }
+
+      let w;
+      try {
+        w = parseToMap(body.infobox);
+      } catch (error) {
+        throw new BadRequestError(`infobox 包含语法错误 ${error}`);
+      }
+
+      let eps = 0;
+      if (body.type === SubjectType.Anime) {
+        eps = Number.parseInt(w.data.get('话数')?.value ?? '0') || 0;
+      } else if (body.type === SubjectType.Real) {
+        eps = Number.parseInt(w.data.get('集数')?.value ?? '0') || 0;
+      }
+
+      const newSubject = {
+        name: body.name,
+        nameCN: w.data.get('中文名')?.value ?? '',
+        platform: body.platform,
+        fieldInfobox: body.infobox,
+        typeID: body.type,
+        fieldSummary: body.summary,
+        fieldEps: eps,
+        updatedAt: DateTime.now().toUnixInteger(),
+      };
+
+      const subjectID = await AppDataSource.transaction(async (txn) => {
+        const s = await txn
+          .getRepository(entity.Subject)
+          .createQueryBuilder()
+          .insert()
+          .values(newSubject)
+          .execute();
+
+        const r = s.raw as ResultSetHeader;
+
+        await txn
+          .getRepository(entity.SubjectFields)
+          .createQueryBuilder()
+          .insert()
+          .values({ subjectID: r.insertId })
+          .execute();
+
+        if (eps) {
+          const episodes = Array.from({ length: eps })
+            .fill(null)
+            .map((_, index) => {
+              return {
+                subjectID: r.insertId,
+                sort: index + 1,
+                type: 0,
+              };
+            });
+
+          await txn
+            .getRepository(entity.Episode)
+            .createQueryBuilder()
+            .insert()
+            .values(episodes)
+            .execute();
+        }
+
+        await txn
+          .getRepository(entity.SubjectRev)
+          .createQueryBuilder()
+          .insert()
+          .values({
+            subjectID: r.insertId,
+            name: newSubject.name,
+            nameCN: newSubject.nameCN,
+            infobox: newSubject.fieldInfobox,
+            summary: newSubject.fieldSummary,
+            createdAt: newSubject.updatedAt,
+            typeID: newSubject.typeID,
+            platform: newSubject.platform,
+            eps: eps,
+            creatorID: auth.userID,
+          })
+          .execute();
+
+        return r.insertId;
+      });
+
+      return { subjectID };
+    },
+  );
+
   type IHistorySummary = Static<typeof HistorySummary>;
   const HistorySummary = t.Object(
     {

routes/private/routes/wiki/subject/index.ts

@@ -1,14 +1,16 @@
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 
+import { StatusCodes } from 'http-status-codes';
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
 
 import { UserGroup } from '@app/lib/auth/index.ts';
 import { projectRoot } from '@app/lib/config.ts';
 import * as image from '@app/lib/image/index.ts';
 import type { IImaginary, Info } from '@app/lib/services/imaginary.ts';
 import * as Subject from '@app/lib/subject/index.ts';
-import type { ISubjectEdit } from '@app/routes/private/routes/wiki/subject/index.ts';
+import { SubjectType } from '@app/lib/subject/index.ts';
+import type { ISubjectEdit, ISubjectNew } from '@app/routes/private/routes/wiki/subject/index.ts';
 import { setup } from '@app/routes/private/routes/wiki/subject/index.ts';
 import { createTestServer } from '@app/tests/utils.ts';
 
@@ -18,6 +20,102 @@ async function testApp(...args: Parameters<typeof createTestServer>) {
   return app;
 }
 
+const newSubjectApp = () =>
+  testApp({
+    auth: {
+      groupID: UserGroup.Normal,
+      login: true,
+      permission: { subject_edit: true },
+      allowNsfw: true,
+      regTime: 0,
+      userID: 100,
+    },
+  });
+
+describe('create subject', () => {
+  test('create new subject', async () => {
+    const app = await newSubjectApp();
+    const res = await app.inject({
+      url: '/subjects',
+      method: 'post',
+      payload: {
+        name: 'New Subject',
+        infobox: `{{Infobox
+        | 话数 = 10
+        }}`,
+        type: SubjectType.Anime,
+        platform: 0,
+        summary: 'A brief summary of the subject',
+        nsfw: false,
+      } satisfies ISubjectNew,
+    });
+
+    expect(res.statusCode).toBe(200);
+
+    expect(res.json()).toEqual({
+      subjectID: expect.any(Number),
+    });
+  });
+
+  test('create type', async () => {
+    const app = await newSubjectApp();
+    const res = await app.inject({
+      url: '/subjects',
+      method: 'post',
+      payload: {
+        name: 'New Subject',
+        infobox: `{{Infobox
+        | 话数 = 10
+        }}`,
+        type: 0,
+        platform: 0,
+        summary: 'A brief summary of the subject',
+        nsfw: false,
+      },
+    });
+
+    expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST);
+
+    expect(res.json()).toMatchInlineSnapshot(`
+      Object {
+        "code": "REQUEST_VALIDATION_ERROR",
+        "error": "Bad Request",
+        "message": "body/type must be equal to constant, body/type must be equal to constant, body/type must be equal to constant, body/type must be equal to constant, body/type must be equal to constant, body/type must match a schema in anyOf",
+        "statusCode": 400,
+      }
+    `);
+  });
+
+  test('invalid platform', async () => {
+    const app = await newSubjectApp();
+    const res = await app.inject({
+      url: '/subjects',
+      method: 'post',
+      payload: {
+        name: 'New Subject',
+        infobox: `{{Infobox
+        | 话数 = 10
+        }}`,
+        type: SubjectType.Anime,
+        platform: 777777888,
+        summary: 'A brief summary of the subject',
+        nsfw: false,
+      },
+    });
+
+    expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST);
+
+    expect(res.json()).toMatchInlineSnapshot(`
+      Object {
+        "code": "BAD_REQUEST",
+        "error": "Bad Request",
+        "message": "条目分类错误",
+        "statusCode": 400,
+      }
+    `);
+  });
+});
+
 describe('edit subject ', () => {
   const editSubject = vi.fn();