@occultus/article-api 0.22.0-alpha.1 → 0.23.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/article-api",
-  "version": "0.22.0-alpha.1",
+  "version": "0.23.0-alpha.1",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -24,15 +24,15 @@
   "license": "MIT",
   "author": "CTN Studios",
   "dependencies": {
-    "@occultus/text-api": "0.20.0"
+    "@occultus/text-api": "0.23.0"
   },
   "peerDependencies": {
-    "@occultus/core": ">=0.18.4 || <0.19.0",
-    "@minecraft/server": ">=2.0.0",
-    "@minecraft/server-ui": ">=2.0.0"
+    "@occultus/core": "1.1.0-rc.1",
+    "@minecraft/server": "^2.4.0",
+    "@minecraft/server-ui": "^2.0.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.9"
+    "typedoc": "^0.28.16"
   },
   "scripts": {
     "test": "tsc"

package/src/api/Article.ts

@@ -1,16 +1,15 @@
 import { Player } from "@minecraft/server";
 import { ActionFormData } from "@minecraft/server-ui";
 import { ChapterData } from "../interface/ChapterData";
-import { BaseArticle } from "./Base/BaseArticle";
 import { parseText, TextProvider } from "@occultus/text-api";
-import { OccultusSDKError } from "@occultus/core";
+import { FormLike } from "@occultus/core";
 
 /**
  * 创建一个文章
  * @category Stable
  * @since 1.0.0
  */
-export class Article extends BaseArticle {
+export class Article extends FormLike {
   /**
    * @param id 文章ID
    * @param title 文章标题
@@ -27,7 +26,7 @@ export class Article extends BaseArticle {
     public iconPath?: string,
     public needUnlock = true
   ) {
-    super(id, title, body, chapters);
+    super();
   }
   /**
    * 向玩家展示文章（文章无章节时）
@@ -35,22 +34,26 @@ export class Article extends BaseArticle {
    * @param backTo 关闭文章后返回的界面
    * @private
    */
-  private simpleDisplay(player: Player, backTo?: BaseArticle): void {
+  private simpleDisplay(player: Player, backTo: FormLike[]): void {
     if (!this.checkUnlock(player)) {
       this.unlock(player);
     }
-    const title = parseText(this.title, player);
-    const body = parseText(this.body, player);
+    const [title, body] = [
+      parseText(this.title, player),
+      parseText(this.body, player)
+    ];
     const mainForm = new ActionFormData()
       .title(title)
       .body(body)
       .button({ translate: "gui.ok" });
-    // @ts-ignore
     mainForm.show(player).then((response) => {
-      if (response.selection === 0 || response.canceled) {
-        backTo?.display(player);
+      if (response.canceled || response.selection === 0) {
+        this.quit(player, backTo);
         return;
       }
+    }).catch((err) => {
+      console.error(`[Article] Failed to display article: ${err}`);
+      this.quit(player, backTo as readonly FormLike[]);
     });
   }
   /**
@@ -59,48 +62,33 @@ export class Article extends BaseArticle {
    * @param backTo 关闭文章后返回的界面
    * @private
    */
-  private chapterDisplay(player: Player, backTo?: BaseArticle): void {
+  private chapterDisplay(player: Player, backTo: FormLike[]): void {
     if (!this.checkUnlock(player)) {
       this.unlock(player);
     }
     const [title, body] = [
       parseText(this.title, player),
-      parseText(this.body, player),
+      parseText(this.body, player)
     ];
     const contentsForm = new ActionFormData().title(title).body(body);
-    if (!this.chapters) {
-      throw new OccultusSDKError("Cannot find chapter data!");
-    }
-    this.chapters.forEach((chapter) => {
+    this.chapters!.forEach((chapter) => {
       const chapterTitle = parseText(chapter.title, player);
       contentsForm.button(chapterTitle, chapter.iconPath);
     });
-    // @ts-ignore
     contentsForm.show(player).then((response) => {
       if (response.canceled || response.selection === undefined) {
-        backTo?.display(player);
+        this.quit(player, backTo);
         return;
       }
-      if (!this.chapters) {
-        throw new OccultusSDKError("Invaild chapter data!");
-      }
       const [chapterTitle, chapterBody] = [
-        parseText(this.chapters[response.selection].title, player),
-        parseText(this.chapters[response.selection].body, player),
+        parseText(this.chapters![response.selection].title, player),
+        parseText(this.chapters![response.selection].body, player)
       ];
-
-      const chapterForm = new ActionFormData()
-        .title(chapterTitle)
-        .body(chapterBody)
-        .button({ translate: "gui.ok" });
-      // @ts-ignore
-      chapterForm.show(player).then((response) => {
-        if (response.selection === 0 || response.canceled) {
-          // @ts-ignore
-          contentsForm.show(player);
-          return;
-        }
-      });
+      const chapter = new Article("temp:chapter", chapterTitle, chapterBody);
+      this.jumpTo(player, chapter, backTo);
+    }).catch((err) => {
+      console.error(`[Article] Failed to display article: ${err}`);
+      this.quit(player, backTo as readonly FormLike[]);
     });
   }
   /**
@@ -108,7 +96,7 @@ export class Article extends BaseArticle {
    * @param player 要展示文章的玩家
    * @param backTo 关闭文章后返回的界面
    */
-  display(player: Player, backTo?: BaseArticle): void {
+  display(player: Player, backTo: FormLike[]): void {
     if (this.chapters) {
       this.chapterDisplay(player, backTo);
       return;
@@ -120,7 +108,9 @@ export class Article extends BaseArticle {
    * @param player
    */
   unlock(player: Player): void {
-    player.addTag(`articleUnlock:${this.id}`);
+    if (this.needUnlock) {
+      player.addTag(`articleUnlock:${this.id}`);
+    }
   }
   /**
    * 检查文章是否在文章中心里解锁

package/src/api/ArticleCenter.ts

@@ -2,9 +2,10 @@ import { Player } from "@minecraft/server";
 import { MessageFormData } from "@minecraft/server-ui";
 import { ArticleRegistries } from "./Base/ArticleRegistries";
 import { Article } from "./Article";
-import { BaseArticle } from "./Base/BaseArticle";
 import { generateContentForm } from "../lib/utils";
 import { TextProvider } from "@occultus/text-api";
+import { FormLike } from "@occultus/core";
+import { ReadableArticle } from "../types/ReadableArticle";
 
 /**
  * 集中显示文章的类
@@ -26,7 +27,7 @@ import { TextProvider } from "@occultus/text-api";
  * @category Stable
  * @since 1.0.0
  */
-export class ArticleCenter extends BaseArticle {
+export class ArticleCenter extends FormLike {
   /**
    * @param id 文章中心ID
    * @param title 文章中心标题
@@ -38,72 +39,70 @@ export class ArticleCenter extends BaseArticle {
     public title: TextProvider,
     public body: TextProvider,
     public articles: Article[] | boolean,
-    public readonly articlesManager: ArticleRegistries,
+    public readonly bindTo: ArticleRegistries,
     public iconPath?: string
   ) {
-    super(id, title, body, articles);
+    super();
   }
   /**
    * 向玩家展示文章中心
    * @param player 要展示文章中心的玩家
    */
-  display(player: Player): void {
-    if (typeof this.articles === "boolean") {
-      if (!this.articles) {
-        this.warn(player);
-        return;
-      }
-      const contentForm = generateContentForm(
-        player,
-        this.title,
-        this.body,
-        this.articlesManager.getAll()
-      );
-      if (!contentForm) {
-        this.warn(player);
-        return;
-      }
-      // @ts-ignore
-      contentForm.form.show(player).then((response) => {
-        if (response.canceled || response.selection === undefined) {
-          return;
-        }
-        contentForm.list[response.selection].display(player, this);
-      });
-      return;
-    }
+  display(player: Player, backTo: FormLike[]): void {
     const contentForm = generateContentForm(
       player,
       this.title,
       this.body,
-      this.articles
+      this.getAvailableArticles()
     );
+
     if (!contentForm) {
-      this.warn(player);
+      this.warn(player, backTo);
       return;
     }
-    // @ts-ignore
-    contentForm.form.show(player).then((response) => {
-      if (response.canceled || response.selection === undefined) {
-        return;
-      }
-      contentForm.list[response.selection].display(player, this);
-    });
+    contentForm.form
+      .show(player)
+      .then((response) => {
+        if (response.canceled || response.selection === undefined) {
+          this.quit(player, backTo);
+          return;
+        }
+        this.jumpTo(player, contentForm.list[response.selection], backTo);
+      })
+      .catch((err) => {
+        console.error(
+          `[ArticleCenter] Failed to display article center: ${err}`
+        );
+        this.quit(player, backTo as readonly FormLike[]);
+      });
+  }
+  private getAvailableArticles(): ReadableArticle[] {
+    if (typeof this.articles === "boolean") {
+      if (!this.articles) return [];
+      return this.bindTo.getAll();
+    }
+    return this.articles;
   }
   /**
    * 当没有可用的文章时，向玩家显示警告
    * @param player 被显示提示的玩家
    * @private
    */
-  private warn(player: Player): void {
+  private warn(player: Player, backTo: FormLike[]): void {
     const warningForm = new MessageFormData()
       .title({ translate: "article.nothing.title" })
       .body({ translate: "article.nothing.body" })
       .button1({ translate: "gui.ok" })
       .button2({ translate: "gui.close" });
-    // @ts-ignore
-    warningForm.show(player).then((_response) => {
-      return;
-    });
+    warningForm
+      .show(player)
+      .then((_response) => {
+        this.quit(player, backTo as readonly FormLike[]);
+        return;
+      })
+      .catch((err) => {
+        console.error(`[ArticleCenter] Failed to display warning form: ${err}`);
+        this.quit(player, backTo as readonly FormLike[]);
+      });
   }
 }

package/src/api/Base/ArticleRegistries.ts

@@ -1,6 +1,5 @@
 import { Registries } from "@occultus/core";
 import { Article } from "../Article";
-import { BaseArticle } from "./BaseArticle";
 import { articleRegister } from "../../lib/utils";
 import { ArticleCenter } from "../ArticleCenter";
 import { ReadableArticle } from "../../types/ReadableArticle";
@@ -51,7 +50,7 @@ export class ArticleRegistries extends Registries {
    * @param id 文章ID
    * @return 返回找到的文章，如果没有找到则返回`undefined`
    */
-  get(id: string): undefined | BaseArticle {
+  get(id: string): undefined | ReadableArticle {
     return this.registry.get(id);
   }
   /**

package/src/index.ts

@@ -5,5 +5,4 @@ export * from "./lib/utils";
 export * from "./api/Article";
 export * from "./api/ArticleCenter";
 export * from "./api/Base/ArticleRegistries";
-export * from "./api/Base/BaseArticle";
 export * from "./interface/ChapterData";

package/src/interface/ChapterData.ts

@@ -1,6 +1,5 @@
 import { TextProvider } from "@occultus/text-api";
 
-
 /**
  * 描述文章的章节数据的接口
  */

package/src/lib/utils.ts

@@ -1,13 +1,6 @@
-import {
-  Player,
-  RawMessage,
-  StartupEvent,
-  system,
-  world,
-} from "@minecraft/server";
+import { Player, StartupEvent } from "@minecraft/server";
 import { ActionFormData } from "@minecraft/server-ui";
 import { Article } from "../api/Article";
-import { BaseArticle } from "../api/Base/BaseArticle";
 import { ReadableArticle } from "../types/ReadableArticle";
 import { TextProvider, parseText } from "@occultus/text-api";
 
@@ -30,7 +23,7 @@ export function generateContentForm(
   const unlockedArticles: ReadableArticle[] = [];
   const [title, body] = [
     parseText(rawTitle, player),
-    parseText(rawBody, player),
+    parseText(rawBody, player)
   ];
   const contentForm = new ActionFormData().title(title).body(body);
   articles.forEach((article) => {
@@ -55,13 +48,12 @@ export function generateContentForm(
 
 export function articleRegister(
   componentId: string,
-  article: BaseArticle,
+  article: ReadableArticle,
   arg: StartupEvent
 ) {
   arg.itemComponentRegistry.registerCustomComponent(componentId, {
     onUse: (callback) => {
-      article.display(callback.source);
-    },
+      article.display(callback.source, []);
+    }
   });
 }
-

package/src/types/ReadableArticle.ts

@@ -4,4 +4,4 @@ import { ArticleCenter } from "../api/ArticleCenter";
 /**
  * 所有可读文章类型
  */
-export type ReadableArticle = Article | ArticleCenter;
+export type ReadableArticle = Article | ArticleCenter;

package/tsconfig.json

@@ -8,7 +8,7 @@
     "noEmit": true,
     "noEmitOnError": true,
     "target": "es2022",
-    "lib": ["es2020", "dom"],
+    "lib": ["es2021", "dom"],
     "strict": true,
     "esModuleInterop": true,
     "module": "es2022",

package/src/api/Base/BaseArticle.ts

@@ -1,26 +0,0 @@
-import { Player } from "@minecraft/server";
-import { TextProvider } from "@occultus/text-api";
-
-/**
- * 描述文章的抽象类
- */
-export abstract class BaseArticle {
-  /**
-   * @param id 文章的唯一标识符
-   * @param title 文章的标题
-   * @param body 文章的内容
-   * @param data 文章的其他数据
-   */
-  constructor(
-    public readonly id: string,
-    public title: TextProvider,
-    public body: TextProvider,
-    public data: unknown
-  ) {}
-  /**
-   * 向玩家展示文章
-   * @param player 要展示文章的玩家
-   * @param backTo 展示后返回的界面
-   */
-  abstract display(player: Player, backTo?: BaseArticle): void;
-}