@minecraft/server 2.2.0-beta.1.21.100-preview.21 → 2.2.0-beta.1.21.100-preview.22

package/index.d.ts

@@ -132,6 +132,35 @@ export enum BlockVolumeIntersection {
     Intersects = 2,
 }
 
+/**
+ * @beta
+ * An enum of error reasons relating to using {@link
+ * ItemBookComponent}.
+ */
+export enum BookErrorReason {
+    /**
+     * @remarks
+     * The requested page content exceeds the max page length of
+     * 256.
+     *
+     */
+    ExceedsMaxPageLength = 'ExceedsMaxPageLength',
+    /**
+     * @remarks
+     * The page could not be created as it would exceed the max
+     * page count of 50.
+     *
+     */
+    ExceedsMaxPages = 'ExceedsMaxPages',
+    /**
+     * @remarks
+     * The title being signed exceeds the maximum title length of
+     * 16.
+     *
+     */
+    ExceedsTitleLength = 'ExceedsTitleLength',
+}
+
 /**
  * The state of a button on a keyboard, controller, or touch
  * interface.
@@ -2037,6 +2066,13 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
+    /**
+     * @beta
+     * @remarks
+     * The minecraft:book component.
+     *
+     */
+    Book = 'minecraft:book',
     Compostable = 'minecraft:compostable',
     /**
      * @remarks
@@ -2983,6 +3019,7 @@ export type ItemComponentReturnType<T extends string> = T extends keyof ItemComp
     : ItemCustomComponentInstance;
 
 export type ItemComponentTypeMap = {
+    book: ItemBookComponent;
     compostable: ItemCompostableComponent;
     cooldown: ItemCooldownComponent;
     durability: ItemDurabilityComponent;
@@ -2990,6 +3027,7 @@ export type ItemComponentTypeMap = {
     enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
     inventory: ItemInventoryComponent;
+    'minecraft:book': ItemBookComponent;
     'minecraft:compostable': ItemCompostableComponent;
     'minecraft:cooldown': ItemCooldownComponent;
     'minecraft:durability': ItemDurabilityComponent;
@@ -12232,6 +12270,214 @@ export class InputInfo {
     getMovementVector(): Vector2;
 }
 
+/**
+ * @beta
+ * When present on an item, this item is a book item. Can
+ * access and modify the contents of the book and sign it.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class ItemBookComponent extends ItemComponent {
+    private constructor();
+    /**
+     * @remarks
+     * The name of the author of the book if it is signed,
+     * otherwise undefined.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly author?: string;
+    /**
+     * @remarks
+     * The contents of pages in the book that are in string format.
+     * Entries not in string format will be undefined.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly contents: (string | undefined)[];
+    /**
+     * @remarks
+     * Determines whether the book has been signed or not.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly isSigned: boolean;
+    /**
+     * @remarks
+     * The amount of pages the book has.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly pageCount: number;
+    /**
+     * @remarks
+     * The contents of pages in the book that are in {@link
+     * RawMessage} format. Entries not in {@link RawMessage} format
+     * will be undefined.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly rawContents: (RawMessage | undefined)[];
+    /**
+     * @remarks
+     * The title of the book if it is signed, otherwise undefined.
+     *
+     * @throws This property can throw when used.
+     *
+     * {@link InvalidItemStackError}
+     */
+    readonly title?: string;
+    static readonly componentId = 'minecraft:book';
+    /**
+     * @remarks
+     * Gets the string format content of a page for a given index.
+     *
+     * @param pageIndex
+     * The index of the page.
+     * @returns
+     * The content of the page if a valid index is provided and it
+     * is in string format, otherwise returns undefined.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidItemStackError}
+     */
+    getPageContent(pageIndex: number): string | undefined;
+    /**
+     * @remarks
+     * Gets the {@link RawMessage} format content of a page for a
+     * given index.
+     *
+     * @param pageIndex
+     * The index of the page.
+     * @returns
+     * The content of the page if a valid index is provided and it
+     * is in {@link RawMessage} format, otherwise returns
+     * undefined.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidItemStackError}
+     */
+    getRawPageContent(pageIndex: number): RawMessage | undefined;
+    /**
+     * @remarks
+     * Inserts a page at a given index. Empty pages will be created
+     * if the index is greater than the current book size.
+     * Pages have a maximum limit of 256 characters for strings as
+     * well as the JSON representation of a {@link RawMessage}.
+     * Books have a maximum limit of 50 pages.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param pageIndex
+     * The index of the page.
+     * @param content
+     * The content to set for the page. Can be a single string or
+     * {@link RawMessage} or an array of strings and/or {@link
+     * RawMessage}s
+     * @throws This function can throw errors.
+     *
+     * {@link BookError}
+     *
+     * {@link BookPageContentError}
+     *
+     * {@link InvalidItemStackError}
+     */
+    insertPage(pageIndex: number, content: (RawMessage | string)[] | RawMessage | string): void;
+    /**
+     * @remarks
+     * Removes a page at a given index. Existing pages following
+     * this page will be moved backward to fill the empty space.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param pageIndex
+     * The index of the page.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidItemStackError}
+     */
+    removePage(pageIndex: number): void;
+    /**
+     * @remarks
+     * Sets the contents of the book's pages. Pre-existing pages
+     * will be cleared.
+     * Pages have a maximum limit of 256 characters for strings as
+     * well as the JSON representation of a {@link RawMessage}.
+     * Books have a maximum limit of 50 pages.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param contents
+     * An array of each page's contents. Each page can be a single
+     * string or {@link RawMessage} or an array of strings and/or
+     * {@link RawMessage}s.
+     * @throws This function can throw errors.
+     *
+     * {@link BookError}
+     *
+     * {@link BookPageContentError}
+     *
+     * {@link InvalidItemStackError}
+     */
+    setContents(contents: ((RawMessage | string)[] | RawMessage | string)[]): void;
+    /**
+     * @remarks
+     * Sets or creates the content of a specific page. Empty pages
+     * will be created if the index is greater than the current
+     * book size.
+     * Pages have a maximum limit of 256 characters for strings as
+     * well as the JSON representation of a {@link RawMessage}.
+     * Books have a maximum limit of 50 pages.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param pageIndex
+     * The index of the page.
+     * @param content
+     * The content to set for the page. Can be a single string or
+     * {@link RawMessage} or an array of strings and/or {@link
+     * RawMessage}s
+     * @throws This function can throw errors.
+     *
+     * {@link BookError}
+     *
+     * {@link BookPageContentError}
+     *
+     * {@link InvalidItemStackError}
+     */
+    setPageContent(pageIndex: number, content: (RawMessage | string)[] | RawMessage | string): void;
+    /**
+     * @remarks
+     * Signs a book giving it a title and author name. Once signed
+     * players can no longer directly edit the book.
+     * Titles have a maximum character limit of 16.
+     *
+     * This function can't be called in read-only mode.
+     *
+     * @param title
+     * The title to give the book.
+     * @param author
+     * The name of the book's author.
+     * @throws This function can throw errors.
+     *
+     * {@link BookError}
+     *
+     * {@link InvalidEntityError}
+     *
+     * {@link InvalidItemStackError}
+     */
+    signBook(title: string, author: string): void;
+}
+
 /**
  * Contains information related to a chargeable item completing
  * being charged.
@@ -21877,6 +22123,51 @@ export class BlockCustomComponentReloadVersionError extends Error {
     private constructor();
 }
 
+/**
+ * @beta
+ * Errors that can be thrown when using {@link
+ * ItemBookComponent}.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BookError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * The reason for the error.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    reason: BookErrorReason;
+}
+
+/**
+ * @beta
+ * The error called if page content being set on an {@link
+ * ItemBookComponent} are invalid ie. exceeding the maximum
+ * page length.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class BookPageContentError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * The index of the page requested to be modified.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    pageIndex: number;
+    /**
+     * @remarks
+     * The reason for the error.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    reason: BookErrorReason;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class CommandError extends Error {
     private constructor();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.2.0-beta.1.21.100-preview.21",
+  "version": "2.2.0-beta.1.21.100-preview.22",
   "description": "",
   "contributors": [
     {
@@ -16,7 +16,7 @@
     "@minecraft/common": "^1.1.0"
   },
   "peerDependencies": {
-    "@minecraft/vanilla-data": ">=1.20.70"
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.100-preview.22"
   },
   "license": "MIT"
 }