@occultus/article-api 0.23.0-alpha.1 → 0.24.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/article-api",
-  "version": "0.23.0-alpha.1",
+  "version": "0.24.0-beta.1",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -24,10 +24,10 @@
   "license": "MIT",
   "author": "CTN Studios",
   "dependencies": {
-    "@occultus/text-api": "0.23.0"
+    "@occultus/text-api": "0.24.0"
   },
   "peerDependencies": {
-    "@occultus/core": "1.1.0-rc.1",
+    "@occultus/core": "^1.1.0",
     "@minecraft/server": "^2.4.0",
     "@minecraft/server-ui": "^2.0.0"
   },

package/src/api/ArticleCenter.ts

@@ -4,7 +4,7 @@ import { ArticleRegistries } from "./Base/ArticleRegistries";
 import { Article } from "./Article";
 import { generateContentForm } from "../lib/utils";
 import { TextProvider } from "@occultus/text-api";
-import { FormLike } from "@occultus/core";
+import { FormLike, OccultusCore, OccultusSDKError } from "@occultus/core";
 import { ReadableArticle } from "../types/ReadableArticle";
 
 /**
@@ -38,8 +38,8 @@ export class ArticleCenter extends FormLike {
     public readonly id: string,
     public title: TextProvider,
     public body: TextProvider,
-    public articles: Article[] | boolean,
-    public readonly bindTo: ArticleRegistries,
+    public articles: ReadableArticle[] | boolean,
+    public readonly bindTo?: ArticleRegistries,
     public iconPath?: string
   ) {
     super();
@@ -79,6 +79,11 @@ export class ArticleCenter extends FormLike {
   private getAvailableArticles(): ReadableArticle[] {
     if (typeof this.articles === "boolean") {
       if (!this.articles) return [];
+      if (!this.bindTo) {
+        throw new OccultusSDKError(
+          "You must bind article registries to the center when using the boolean parameter!"
+        );
+      }
       return this.bindTo.getAll();
     }
     return this.articles;

package/src/api/Bindings/ArticleServerBindings.ts

@@ -0,0 +1,182 @@
+import { ItemStack, RawMessage, StartupEvent, system } from "@minecraft/server";
+import { ArticleBindingConfig } from "./BindingConfig";
+import { OccultusSDKError } from "@occultus/core";
+import { parseText, TextProvider } from "@occultus/text-api";
+import { ChapterData } from "../../interface/ChapterData";
+import { ReadableArticle } from "../../types/ReadableArticle";
+import { Article } from "../Article";
+import {
+  ArticleCenterComponentParams,
+  ArticleComponentParams,
+  ArticleContentParams
+} from "./ComponentParams";
+import { ArticleCenter } from "../ArticleCenter";
+
+/**
+ * 文章内容类型别名
+ */
+type ArticleContent =
+  | TextProvider
+  | { chapter: ChapterData[]; description: TextProvider };
+
+export class ArticleServerBindings {
+  private static instance: ArticleServerBindings | undefined;
+  private static center: ArticleCenter | undefined;
+  private preloadedContent: Map<string, ArticleContent> = new Map();
+  private articles: Map<string, ReadableArticle> = new Map();
+  /**
+   * 获取文章的内容
+   * @param item
+   * @param config
+   * @returns
+   */
+  private getArticleContent(item: ItemStack, config: ArticleBindingConfig) {
+    const params = item.getComponent(config.contentComponentName)
+      ?.customComponentParameters.params as ArticleContentParams;
+    if (!params) return;
+    if (typeof params === "string") {
+      return this.preloadedContent.get(params);
+    }
+    return params;
+  }
+  private parseDescription(text: ArticleContent | RawMessage[]): TextProvider {
+    if (typeof text === "string") return text;
+    if (Array.isArray(text)) {
+      return {
+        rawtext: text
+      };
+    }
+    if ("description" in text) {
+      return text.description;
+    }
+    return text;
+  }
+  private registryArticleComponent(
+    event: StartupEvent,
+    config: ArticleBindingConfig
+  ) {
+    const self = this;
+    event.itemComponentRegistry.registerCustomComponent(config.componentName, {
+      onUse(event, componentParams) {
+        const { itemStack, source } = event;
+        const params = componentParams.params as ArticleComponentParams;
+        if (!itemStack) return;
+        // 该文章已经被注册
+        if (self.articles.has(itemStack.typeId)) {
+          self.articles.get(itemStack.typeId)?.display(source, []);
+          return;
+        }
+        // 该文章没有被注册，先注册一下
+        const content = self.getArticleContent(itemStack, config);
+        let article: ReadableArticle;
+        if (!content) return;
+        if (typeof content !== "string" && "chapter" in content) {
+          article = new Article(
+            itemStack.typeId,
+            params.title,
+            content.description,
+            content.chapter,
+            params.icon_path
+          );
+          self.articles.set(itemStack.typeId, article);
+          article.display(source, []);
+          return;
+        }
+        article = new Article(
+          itemStack.typeId,
+          params.title,
+          self.parseDescription(content),
+          undefined,
+          params.icon_path
+        );
+        self.articles.set(itemStack.typeId, article);
+        article.display(source, []);
+      }
+    });
+  }
+  private registryArticleContentComponent(
+    event: StartupEvent,
+    config: ArticleBindingConfig
+  ) {
+    event.itemComponentRegistry.registerCustomComponent(
+      config.contentComponentName,
+      {}
+    );
+  }
+  private registryArticleCenterContent(
+    event: StartupEvent,
+    config: ArticleBindingConfig
+  ) {
+    const self = this;
+    event.itemComponentRegistry.registerCustomComponent(
+      config.centerComponentName,
+      {
+        onUse(event, componentParams) {
+          const { itemStack, source } = event;
+          const params = componentParams.params as ArticleCenterComponentParams;
+          if (!itemStack) return;
+          const center = ArticleServerBindings.center;
+          if (!center) {
+            const newCenter = new ArticleCenter(
+              itemStack.typeId,
+              params.title,
+              params.description,
+              Array.from(self.articles.values()),
+              undefined,
+              params.icon_path
+            );
+            ArticleServerBindings.center = newCenter;
+            newCenter.display(source, []);
+            return;
+          }
+          center.display(source, []);
+        }
+      }
+    );
+  }
+  private constructor(public config: ArticleBindingConfig) {
+    if (!config) {
+      throw new OccultusSDKError("ArticleBindingConfig is required!");
+    }
+    system.beforeEvents.startup.subscribe((event) => {
+      this.registryArticleComponent(event, config);
+      this.registryArticleContentComponent(event, config);
+      this.registryArticleCenterContent(event, config);
+    });
+  }
+  static create(config: ArticleBindingConfig): void {
+    if (ArticleServerBindings.instance) {
+      throw new OccultusSDKError("ArticleServerBindings already created!");
+    }
+    ArticleServerBindings.instance = new ArticleServerBindings(config);
+  }
+  static getInstance(): ArticleServerBindings {
+    if (!ArticleServerBindings.instance) {
+      throw new OccultusSDKError("ArticleServerBindings not created!");
+    }
+    return ArticleServerBindings.instance;
+  }
+  static getCenter(): ArticleCenter {
+    if (!ArticleServerBindings.center) {
+      throw new OccultusSDKError("ArticleCenter not found!");
+    }
+    return ArticleServerBindings.center;
+  }
+  /**
+   * 预载文章内容
+   * @param id
+   * @param content
+   */
+  preloadContent(
+    id: string,
+    content:
+      | TextProvider
+      | { chapter: ChapterData[]; description: TextProvider }
+  ) {
+    if (!id || !content) {
+      console.warn(`Preload data failed with id: ${id}`);
+      return;
+    }
+    this.preloadedContent.set(id, content);
+  }
+}

package/src/api/Bindings/BindingConfig.ts

@@ -0,0 +1,5 @@
+export type ArticleBindingConfig = {
+  componentName: string;
+  centerComponentName: string;
+  contentComponentName: string;
+};

package/src/api/Bindings/ComponentParams.ts

@@ -0,0 +1,14 @@
+import { RawMessage } from "@minecraft/server";
+
+export type ArticleComponentParams = {
+  title: RawMessage | string;
+  icon_path?: string;
+};
+
+export type ArticleContentParams = RawMessage[] | string;
+
+export type ArticleCenterComponentParams = {
+  title: RawMessage | string;
+  description: RawMessage | string;
+  icon_path?: string;
+};

package/src/index.ts

@@ -6,3 +6,6 @@ export * from "./api/Article";
 export * from "./api/ArticleCenter";
 export * from "./api/Base/ArticleRegistries";
 export * from "./interface/ChapterData";
+export * from "./api/Bindings/ArticleServerBindings";
+export * from "./api/Bindings/BindingConfig";
+export * from "./api/Bindings/ComponentParams";