feat: lyrio platform

Author: typed-sigterm

README.md

@@ -31,6 +31,7 @@ Currently supported platforms:
 - [Codeforces](https://jsr.io/@un-oj/core/doc/platforms/codeforces) (`/platforms/codeforces`)
 - [Hydro](https://jsr.io/@un-oj/core/doc/platforms/hydro) (`/platforms/hydro`)
 - [LeetCode](https://jsr.io/@un-oj/core/doc/platforms/leetcode) (`/platforms/leetcode`)
+- [Lyrio](https://jsr.io/@un-oj/core/doc/platforms/lyrio) (LibreOJ) (`/platforms/lyrio`)
 - [Luogu](https://jsr.io/@un-oj/core/doc/platforms/luogu) (`/platforms/luogu`)
 - [MXOJ](https://jsr.io/@un-oj/core/doc/platforms/mxoj) (`/platforms/mxoj`)
 

jsr.json

@@ -8,6 +8,7 @@
     "./platforms/codeforces": "./src/platforms/codeforces.ts",
     "./platforms/hydro": "./src/platforms/hydro.ts",
     "./platforms/leetcode": "./src/platforms/leetcode.ts",
+    "./platforms/lyrio": "./src/platforms/lyrio.ts",
     "./platforms/luogu": "./src/platforms/luogu.ts",
     "./platforms/mxoj": "./src/platforms/mxoj.ts"
   },

src/platforms/lyrio.ts

@@ -0,0 +1,112 @@
+/**
+ * Lyrio platform, which is used by [LibreOJ](https://loj.ac) under the hood.
+ * @module
+ */
+
+import type { PlatformOptions } from '../platform';
+import type { Problem as BaseProblem } from '../problem';
+import { NotFoundError, Platform, UnexpectedResponseError } from '../platform';
+import { UnOJError } from '../utils';
+
+export type ProblemType = 'Traditional' | 'SubmitAnswer' | 'Interaction';
+
+/**
+ * Lyrio-specific problem type.
+ *
+ * Description is JSON-encoded Markdown.
+ *
+ * @example
+ * ```ts
+ * ({
+ *   description: `[{"sectionTitle":"题目描述","type":"Text","text":"输入 $ a $ 和 $ b $，输出 $ a + b $ 的结果。"},{"sectionTitle":"输入格式","type":"Text","text":"一行两个正整数 $ a $ 和 $ b $。"},{"sectionTitle":"输出格式","type":"Text","text":"一行一个正整数 $ a + b $。"},{"sectionTitle":"样例","type":"Sample","sampleId":0,"text":"根据数学知识有 $ 1 + 2 = 3 $。"},{"sectionTitle":"数据范围","type":"Text","text":"对于 $ 100\\% $ 的数据，$ 1 \\leq a, b \\leq 10 ^ 6 $。"}]`,
+ *   difficulty: undefined,
+ *   id: '1',
+ *   link: 'https://loj.ac/p/1',
+ *   memoryLimit: 536870912,
+ *   samples: [{
+ *     input: '1 2',
+ *     output: '3',
+ *   }],
+ *   tags: [{
+ *     color: 'black',
+ *     id: 1,
+ *     name: '系统测试',
+ *     nameLocale: 'zh_CN',
+ *   }],
+ *   timeLimit: 2000,
+ *   title: 'A + B 问题',
+ *   type: 'Traditional',
+ * })
+ * ```
+ */
+export type Problem = BaseProblem<
+  string,
+  number,
+  undefined,
+  Array<{ id: number, name: string, color: string }>,
+  ProblemType
+>;
+
+export const DEFAULT_BASE_URL = 'https://api.loj.ac';
+
+/**
+ * Lyrio platform.
+ *
+ * I18n is supported.
+ */
+export default class Lyrio extends Platform<string> {
+  constructor(options?: PlatformOptions<string>) {
+    super(options, DEFAULT_BASE_URL);
+  }
+
+  /** Fetches a problem from LibreOJ using API. */
+  override async getProblem(id: string): Promise<Problem> {
+    const displayId = Number.parseInt(id);
+    if (Number.isNaN(displayId))
+      throw new NotFoundError('problem');
+
+    let data: any;
+    try {
+      data = await this.ofetch('/api/problem/getProblem', {
+        method: 'POST',
+        body: {
+          displayId,
+          localizedContentsOfLocale: this.locale || 'zh_CN',
+          tagsOfLocale: this.locale || 'zh_CN',
+          samples: true,
+          judgeInfo: true,
+          judgeInfoToBePreprocessed: true,
+          statistics: false,
+          discussionCount: false,
+          permissionOfCurrentUser: false,
+          lastSubmissionAndLastAcceptedSubmission: false,
+        },
+        responseType: 'json',
+      });
+    } catch (e) {
+      throw new UnOJError(`Failed to fetch problem ${id}`, { cause: e });
+    }
+
+    if (data.error === 'NO_SUCH_PROBLEM')
+      throw new NotFoundError('problem');
+    if (!data.meta || !data.localizedContentsOfLocale)
+      throw new UnexpectedResponseError(data);
+
+    return {
+      id,
+      type: data.meta.type,
+      title: data.localizedContentsOfLocale.title,
+      link: `https://loj.ac/p/${displayId}`,
+      description: JSON.stringify(data.localizedContentsOfLocale.contentSections),
+
+      samples: data.samples.map((sample: any) => ({
+        input: sample.inputData,
+        output: sample.outputData,
+      })),
+      timeLimit: data.judgeInfo.timeLimit,
+      memoryLimit: data.judgeInfo.memoryLimit * 1024 * 1024,
+      tags: data.tagsOfLocale || [],
+      difficulty: undefined,
+    };
+  }
+}

src/problem.ts

@@ -14,12 +14,18 @@ export interface ProblemDescriptionObject {
   hint: string
 }
 
+/** A tag for a {@link Problem}. */
+export interface TagInfo<Id extends string | number = string | number> {
+  id: Id
+  name: string
+}
+
 /** General problem information. */
 export interface Problem<
   Desc extends string | ProblemDescriptionObject = string | ProblemDescriptionObject,
   Limits extends number | number[] | undefined = number | number[] | undefined,
   Difficulty extends string | number | undefined = string | number | undefined,
-  Tags extends string[] | number[] | undefined = string[] | number[] | undefined,
+  Tags extends TagInfo[] = TagInfo[],
   Type extends string = string,
 > {
   id: string

tests/platforms/__snapshots__/lyrio.spec.ts.snap

@@ -0,0 +1,65 @@
+// Bun Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Lyrio platform (problem) should work 1`] = `
+{
+  "description": "[{"sectionTitle":"题目描述","type":"Text","text":"输入 $ a $ 和 $ b $，输出 $ a + b $ 的结果。"},{"sectionTitle":"输入格式","type":"Text","text":"一行两个正整数 $ a $ 和 $ b $。"},{"sectionTitle":"输出格式","type":"Text","text":"一行一个正整数 $ a + b $。"},{"sectionTitle":"样例","type":"Sample","sampleId":0,"text":"根据数学知识有 $ 1 + 2 = 3 $。"},{"sectionTitle":"数据范围","type":"Text","text":"对于 $ 100\\\\% $ 的数据，$ 1 \\\\leq a, b \\\\leq 10 ^ 6 $。"}]",
+  "difficulty": undefined,
+  "id": "1",
+  "link": "https://loj.ac/p/1",
+  "memoryLimit": 536870912,
+  "samples": [
+    {
+      "input": "1 2",
+      "output": "3",
+    },
+  ],
+  "tags": [
+    {
+      "color": "black",
+      "id": 1,
+      "name": "系统测试",
+      "nameLocale": "zh_CN",
+    },
+  ],
+  "timeLimit": 2000,
+  "title": "A + B 问题",
+  "type": "Traditional",
+}
+`;
+
+exports[`Lyrio platform (problem) should work 2`] = `
+{
+  "description": "[{"sectionTitle":"题目描述","type":"Text","text":"输出 \`Hello, World!\`，大小写不限。"},{"sectionTitle":"样例 1","type":"Sample","sampleId":0,"text":""},{"sectionTitle":"样例 2","type":"Sample","sampleId":1,"text":""}]",
+  "difficulty": undefined,
+  "id": "2",
+  "link": "https://loj.ac/p/2",
+  "memoryLimit": 268435456,
+  "samples": [
+    {
+      "input": "",
+      "output": "Hello, World!",
+    },
+    {
+      "input": "",
+      "output": "hello, WORLD!",
+    },
+  ],
+  "tags": [
+    {
+      "color": "black",
+      "id": 1,
+      "name": "系统测试",
+      "nameLocale": "zh_CN",
+    },
+    {
+      "color": "violet",
+      "id": 4,
+      "name": "Special Judge",
+      "nameLocale": "zh_CN",
+    },
+  ],
+  "timeLimit": 1000,
+  "title": "你好，世界！",
+  "type": "Traditional",
+}
+`;

tests/platforms/lyrio.spec.ts

@@ -0,0 +1,17 @@
+import { NotFoundError } from '@un-oj/core';
+import Lyrio from '@un-oj/core/platforms/lyrio';
+import { describe, expect, it } from 'bun:test';
+import { assertProblem } from './utils';
+
+describe('Lyrio platform (problem)', () => {
+  const loj = new Lyrio();
+
+  it('should work', async () => {
+    assertProblem(await loj.getProblem('1'));
+    assertProblem(await loj.getProblem('2'));
+  });
+
+  it('should throw NotFoundError w/ non-existent problem', async () => {
+    expect(loj.getProblem('999999')).rejects.toThrow(NotFoundError);
+  });
+});