@wayward/types 2.15.5-beta.dev.20260531.1 → 2.15.5-beta.dev.20260602.1

package/definitions/game/game/item/ItemManager.d.ts

@@ -113,6 +113,9 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
     private static readonly cachedItemsThatCanBeRelic;
     private static readonly cachedRuneChanceRanges;
     static readonly cachedItemSpawns: Map<BiomeType, Map<WorldZ, Map<TerrainType, ItemType[]>>>;
+    private getSyncCheckContainerDebug;
+    private getSyncCheckItemDebug;
+    private getSyncCheckItemIdentity;
     static getItemTypes(): readonly ItemType[];
     static getRuneChanceRange(deity: DeityReal): IRange;
     static getItemsWithRecipes(): readonly ItemType[];

package/definitions/game/multiplayer/Multiplayer.d.ts

@@ -19,6 +19,9 @@ import type { IPacket } from "@wayward/game/multiplayer/packets/IPacket";
 import DesyncPacket from "@wayward/game/multiplayer/packets/server/DesyncPacket";
 import type { IServerMod } from "@wayward/hosts/shared/interfaces";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
+export interface ISyncRegionHandle extends Disposable {
+    dispose(): void;
+}
 export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
     /**
      * Static steam account id when steam support is on
@@ -172,8 +175,29 @@ export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
      * Active means there's a current sync check being recorded
      */
     isSyncCheckEnabled(syncCheck: MultiplayerSyncCheck): boolean;
+    /**
+     * Opens a sync check region and returns a disposable handle that closes it.
+     *
+     * Erasable sync regions that don't contain a fork are removed from desync reports.
+     */
+    addSyncRegion(syncCheck: MultiplayerSyncCheck, value: any): ISyncRegionHandle;
+    /**
+     * Opens a sync check region and returns a disposable handle that closes it.
+     */
+    addSyncRegion(id: string): ISyncRegionHandle;
+    /**
+     * Opens an erasable sync check region and returns a disposable handle that closes it.
+     *
+     * Erasable regions are removed from collapsed desync reports when they match on both sides.
+     */
+    addErasableSyncRegion(syncCheck: MultiplayerSyncCheck, value: any): ISyncRegionHandle;
+    addErasableSyncRegion(id: string): ISyncRegionHandle;
+    private createSyncRegion;
     addSyncCheck(syncCheck: MultiplayerSyncCheck, value: any, addStackTrace?: boolean): void;
+    addErasableSyncCheck(syncCheck: MultiplayerSyncCheck, value: any, addStackTrace?: boolean): void;
+    private addSyncCheckInternal;
     addSyncCheckWithSeed(island: Island, syncCheck: MultiplayerSyncCheck, ...messages: any[]): void;
+    addErasableSyncCheckWithSeed(island: Island, syncCheck: MultiplayerSyncCheck, ...messages: any[]): void;
     addBeforeSyncChecks(packet: IPacket): void;
     addAfterSyncChecks(packet: IPacket): void;
     sendChatMessage(sender: Player, message: string): Promise<void>;

package/definitions/game/multiplayer/SyncRegion.d.ts

@@ -8,15 +8,21 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-type Decorator = (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-/**
- * **Note:** Do not intentionally throw errors through this decorated function. It does not close the region if an error is thrown.
- */
+type SyncRegionDecorator<TARGET, ARGS extends any[]> = <RETURN>(target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<(this: TARGET, ...args: ARGS) => RETURN>) => TypedPropertyDescriptor<(this: TARGET, ...args: ARGS) => RETURN> | void;
+export declare const erasableSyncRegionPrefix = "!";
+export declare const erasableSyncCheckPrefix = "!";
+export interface ISyncRegionOptions<T = any, ARGS extends any[] = any[]> {
+    erasable?: boolean;
+    render?: (target: T, ...args: ARGS) => string;
+}
+export declare function collapseSyncCheckRegions(syncChecks: readonly string[]): string[];
+export declare function collapseSharedSyncCheckRegions(serverSyncChecks: readonly string[], clientSyncChecks: readonly string[]): [string[], string[]];
+export declare function formatSyncCheckRegion(syncCheck: string): string;
 export default function SyncRegion(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
-/**
- * **Note:** Do not intentionally throw errors through this decorated function. It does not close the region if an error is thrown.
- *
- * **Warning:** Do not combine this with other decorators.
- */
-export default function SyncRegion<T>(detailProvider: (target: T) => string): Decorator;
+export default function SyncRegion<T, const F extends (target: T, arg: any, ...args: any[]) => string>(detailProvider: F): SyncRegionDecorator<T, F extends (target: T, ...args: infer ARGS) => string ? ARGS : []>;
+export default function SyncRegion<T>(detailProvider: (target: T) => string): SyncRegionDecorator<T, any[]>;
+export default function SyncRegion<T, ARGS extends [any, ...any[]]>(options: ISyncRegionOptions<T, ARGS> & {
+    render: (target: T, ...args: ARGS) => string;
+}): SyncRegionDecorator<T, ARGS>;
+export default function SyncRegion<T>(options: ISyncRegionOptions<T>): SyncRegionDecorator<T, any[] | []>;
 export {};

package/definitions/game/multiplayer/packets/IPacket.d.ts

@@ -24,6 +24,7 @@ export interface ISynchronizationCheckData {
     afterSyncChecksHash?: number;
 }
 export interface ISyncCheck {
+    erasable?: true;
     id: MultiplayerSyncCheck;
     value: string | number;
 }

package/definitions/lint/use-using-disposable.d.mts

@@ -0,0 +1,28 @@
+declare namespace _default {
+    export namespace meta {
+        export let type: string;
+        export namespace docs {
+            let description: string;
+            let category: string;
+            let recommended: boolean;
+        }
+        export { messages };
+        export let schema: never[];
+    }
+    export { createRuleListener as create };
+}
+export default _default;
+export type Context = TSESLint.RuleContext<keyof typeof messages, []>;
+declare namespace messages {
+    let useUsing: string;
+    let useAwaitUsing: string;
+    let holdWithUsing: string;
+    let holdWithAwaitUsing: string;
+}
+/**
+ * @param {Context} context
+ * @returns {TSESLint.RuleListener}
+ */
+declare function createRuleListener(context: Context): ESLintUtils.RuleListener;
+import type { TSESLint } from '@typescript-eslint/utils';
+import { ESLintUtils } from "@typescript-eslint/utils";

package/definitions/test/suite/unitTests/game/multiplayer/SyncRegion.spec.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2025 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { TestConfig } from "@wayward/test";
+import type { IPaths } from "@wayward/test/interfaces";
+export default function (paths: IPaths, config: TestConfig): void;

package/definitions/utilities/log/ErrorReportAttachments.d.ts

@@ -11,7 +11,6 @@
 declare namespace ErrorReportAttachments {
     const MAX_ATTACHMENTS = 4;
     const MAX_ATTACHMENT_BYTES: number;
-    const MAX_TOTAL_ATTACHMENT_BYTES: number;
     interface IAttachment {
         filename: string;
         contentType: string;
@@ -19,7 +18,7 @@ declare namespace ErrorReportAttachments {
     }
     interface IValidationResult {
         attachments: IAttachment[];
-        error?: string;
+        notices: string[];
         totalBytes: number;
     }
     function validate(attachments: readonly IAttachment[] | undefined): IValidationResult;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.15.5-beta.dev.20260531.1",
+	"version": "2.15.5-beta.dev.20260602.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",