@wayward/types 2.14.4-beta.dev.20250102.1 → 2.14.4-beta.dev.20250104.1

package/definitions/game/save/upgrade/UpgradeVersionRegistry.d.ts

@@ -11,8 +11,10 @@
 import type { IUpgradeVersion, UpgradeParameters, UpgradeType } from "@wayward/game/save/upgrade/UpgradeVersion";
 import type UpgradesArray from "@wayward/game/save/upgrade/UpgradesArray";
 import type Version from "@wayward/utilities/Version";
+import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
 export declare const BUILD_TIME_INTRODUCED_TIME: Date;
 declare namespace UpgradeVersionRegistry {
+    function getMostRecentBuildId(): IBuildId | undefined;
     function getAll(): readonly IUpgradeVersion[];
     function run<TYPE extends UpgradeType>(version: Version.Info, messages: UpgradesArray, which: TYPE, ...params: UpgradeParameters<TYPE>): void;
 }

package/definitions/game/steamworks/Steamworks.d.ts

@@ -12,7 +12,7 @@ import type { HeapStatistics } from "electron";
 import type { Game } from "@wayward/game/game/Game";
 import type Entity from "@wayward/game/game/entity/Entity";
 import IActionContext from "@wayward/game/game/entity/action/IActionContext";
-import { ModType } from "@wayward/game/mod/IModInformation";
+import { ModState, ModType } from "@wayward/game/mod/IModInformation";
 import type { ModInformation } from "@wayward/game/mod/ModInformation";
 import type { IJoinServerOptions, ServerInfo } from "@wayward/game/multiplayer/IMultiplayer";
 import type { IDedicatedServerInfo, IModPath, ISteamworksEvents, RunningContext, SteamStatTypeValues } from "@wayward/game/steamworks/ISteamworks";
@@ -219,6 +219,10 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
     private refreshSetupMods;
     private cleanupTemporaryLocalFiles;
     private cleanupTemporaryRemoteFiles;
+    /**
+     * Called when the overlay is closed or when the refresh mods button is clicked
+     */
+    refreshWorkshopMods(waitForRefresh?: boolean, initialModState?: ModState.Enabled | ModState.Disabled): Promise<void>;
     private refreshPublishedMods;
     private getIdFromWorkshopItem;
     private syncWorkshopItems;

package/definitions/game/ui/component/Component.d.ts

@@ -94,6 +94,7 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
      */
     get selectable(): SelectableLayer | false;
     constructor(elementType?: string, namespace?: Namespace);
+    toString(): string;
     /**
      * Alias of `.element.addEventListener`, except it returns `this` instead and prevents memory leaks
      */

package/definitions/game/ui/screen/screens/game/component/InspectionsList.d.ts

@@ -30,7 +30,6 @@ export default abstract class InspectionsList<INSPECTIONS_HANDLER extends Inspec
     event: IEventEmitter<this, ITileInspectionsEvents>;
     private readonly paragraphInspectionsInvalid;
     private inspectTypeFilter;
-    private _removed?;
     protected inspectionsHandler?: InspectionsHandler;
     protected refreshPromiseSequence: PromiseSequence;
     protected inspectionsHandlerUpdatedInspectionsCallback?: (_: any, inspectType: InspectType, inspections: HashSet<Inspection<any>>, oldInspections: HashSet<Inspection<any>> | undefined) => void;

package/definitions/game/ui/screen/screens/game/dialog/QuestDialog.d.ts

@@ -27,6 +27,7 @@ export default class QuestDialog extends Dialog {
     private readonly childQuestsHeading;
     private readonly childQuests;
     private readonly completeQuestButton;
+    private readonly activateQuestButton;
     private current;
     constructor();
     getBindable(): Bindable;

package/definitions/game/ui/tooltip/Tooltip.d.ts

@@ -43,9 +43,9 @@ export default class Tooltip extends Component {
     private forceShown;
     private maxWidth;
     private hasSetPosition;
-    initialized?: Promise<any>;
+    initialized?: Promise<boolean>;
     context?: InfoProviderContext;
-    constructor(source: Component | HTMLElement, initialize?: (tooltip: Tooltip) => any);
+    constructor(source: Component | HTMLElement, initialize?: (tooltip: Tooltip) => Promise<boolean>);
     protected onRemove(): void;
     setSecondary(): this;
     setForceShown(forceShown?: boolean): this;

package/definitions/game/ui/util/ComponentManipulator.d.ts

@@ -8,6 +8,7 @@
  * 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 Component from "@wayward/game/ui/component/Component";
 export type Until<T> = Record<string, (...args: any[]) => T>;
 export type UntilHandler<T, U extends Until<T>> = {
     [key in keyof U]: {
@@ -16,7 +17,7 @@ export type UntilHandler<T, U extends Until<T>> = {
     };
 };
 type EmptyIfUndefined<T> = T extends undefined ? Empty : T;
-export declare abstract class Manipulator<T, U extends Until<T> | undefined = undefined> {
+export declare abstract class Manipulator<T extends Component, U extends Until<T> | undefined = undefined> {
     protected readonly element: () => HTMLElement;
     protected readonly host: T;
     protected getUntilHandler?(): UntilHandler<T, EmptyIfUndefined<U>>;
@@ -32,7 +33,7 @@ export interface ClassUntil<T> extends Until<T> {
     remove(...classes: string[]): T;
     toggle(hasClass: boolean, ...classes: string[]): T;
 }
-export declare class ClassManipulator<T> extends Manipulator<T, ClassUntil<T>> {
+export declare class ClassManipulator<T extends Component> extends Manipulator<T, ClassUntil<T>> {
     protected getUntilHandler(): {
         add: {
             start: (...classes: string[]) => T;
@@ -68,7 +69,7 @@ export interface AttributeUntil<T> extends Until<T> {
     set(attribute: string, value: string): T;
     set(attributes: Iterable<[string, string | null]>): T;
 }
-export declare class AttributeManipulator<T> extends Manipulator<T, AttributeUntil<T>> {
+export declare class AttributeManipulator<T extends Component> extends Manipulator<T, AttributeUntil<T>> {
     protected getUntilHandler(): {
         set: any;
     };
@@ -80,7 +81,7 @@ export declare class AttributeManipulator<T> extends Manipulator<T, AttributeUnt
     has(...attributes: string[]): boolean;
     private getAttributeIterator;
 }
-export declare class DataManipulator<T> extends Manipulator<T> {
+export declare class DataManipulator<T extends Component> extends Manipulator<T> {
     set(name: string, value: string): T;
     set(data: Iterable<[string, string | undefined]>): T;
     get(name: string): string;
@@ -92,7 +93,7 @@ export declare class DataManipulator<T> extends Manipulator<T> {
 export interface StyleUntil<T> extends Until<T> {
     set(rule: string, value: string): T;
 }
-export declare class StyleManipulator<T> extends Manipulator<T, StyleUntil<T>> {
+export declare class StyleManipulator<T extends Component> extends Manipulator<T, StyleUntil<T>> {
     protected getUntilHandler(): {
         set: {
             start: (rule: string, value: string | number) => T;

package/definitions/game/utilities/Observer.d.ts

@@ -57,7 +57,7 @@ declare namespace Observer {
         start(): void;
         end(): void;
         setDefaultPriority(priority?: number): this;
-        inherit(registrar: IRegistrar<any>): void;
+        inherit(registrar: IRegistrar<any>): HOST;
     }
     export function createRegistrar<HOST>(host: HOST, handler: () => any): IRegistrar<HOST>;
     export {};

package/definitions/game/utilities/memory/MemoryLeakDetector.d.ts

@@ -16,11 +16,17 @@ declare class MemoryLeakDetector {
     private objectsCollected;
     private readonly objects;
     private activeTask;
+    private queuedGarbageCollectionTimeoutId;
     get isReportingErrors(): boolean;
     get isMonitoring(): boolean;
     getCount(prefix: string): number;
+    /**
+     * Queues a garbage collection to run after a delay
+     * @param delay Delay in milliseconds
+     */
+    queueNextGarbageCollection(delay?: number): void;
     waitForIdle(): Promise<void>;
-    register(object: object, objectName: string, expectedLifetime: ExpectedLifetime, parentObjectIdentifier?: string): void;
+    register(object: object, objectName: string, expectedLifetime: ExpectedLifetime, parentObjectIdentifier?: string, includeStackTrace?: boolean): void;
     registerMultiple<T extends object>(prefix: string, objects: SaferArray<T>, objectNamer: (object: T) => string, expectedLifetime: ExpectedLifetime): void;
     onStopPlay(): void;
     onScreenShow(_: any, screen: Screen): Promise<any>;

package/definitions/server/error/util/SendDiscordMessage.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2011-2024 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
+ */
+export interface IDiscordMessage {
+    color?: number;
+    author?: string;
+    title: string;
+    url?: string;
+    description?: string;
+    footer?: string;
+}
+export default function (message: IDiscordMessage): Promise<void>;

package/definitions/utilities/Log.d.ts

@@ -87,6 +87,7 @@ declare namespace Log {
         Memory = 2
     }
     function setMemoryLog(memoryLog: MemoryLog | undefined): void;
+    function setTimestampType(type: "full" | "build"): void;
     function disableFileLogger(): void;
     function disableFileLoggingForSource(source: string): void;
     function initializeGameState(): void;

package/definitions/utilities/Version.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { IBuild, IBuildId } from "@wayward/hosts/shared/globalTypes";
+import type { IFileSystem } from "@wayward/hosts/shared/ipc/fileSystem";
 export interface IVersionInfo {
     str: Version.String;
     strSemver: Version.StringSemVer;
@@ -30,7 +31,7 @@ export declare namespace IVersionInfo {
     }
 }
 declare namespace Version {
-    export function readBuildFile(): Promise<IBuild | undefined>;
+    export function readBuildFile(path?: string, fs?: IFileSystem): Promise<IBuild | undefined>;
     export type Stage = "beta" | "release";
     export type String = `${Stage}${bigint}.${bigint}.${bigint}` | `${Stage}${bigint}.${bigint}` | `${Stage}${bigint}`;
     export type StringSemVer = `${bigint}.${bigint}.${bigint}-${Stage}` | `${bigint}.${bigint}.${bigint}`;
@@ -68,7 +69,7 @@ declare namespace Version {
     export function createRawVersionInfo(stage: Version.Stage, major: number, minor: number, patch?: number, date?: Date): IVersionInfo;
     export function convertStringToRawInfo(version: Version.String | Version.StringSemVer | Version.StringBuildId): IVersionInfo;
     export function create(stage: Version.Stage, major: number, minor: number, patch?: number, date?: Date): Info;
-    export function getVersionInfo(version: IVersionInfo | Version.String | Version.StringSemVer | Version.StringBuildId): Info;
+    export function getVersionInfo(version?: IVersionInfo | Version.String | Version.StringSemVer | Version.StringBuildId): Info;
     export function isSameVersion(version: IVersionInfo, compareVersion: IVersionInfo): boolean;
     const timezones: {
         nz: string;

package/definitions/utilities/event/EventEmitter.d.ts

@@ -79,6 +79,10 @@ export interface IEventEmitter<H = any, E = any> {
     until<E2>(emitter: IEventEmitterHost<E2>, ...events: Array<keyof E2>): IUntilSubscriber<H, E>;
     until(promise: Promise<any>): IUntilSubscriber<H, E>;
     hasHandlersForEvent(...events: Array<keyof E>): boolean;
+    /**
+     * Closes an event emitter, which will prevent any further subscriptions from being made.
+     */
+    close(): void;
 }
 export interface IUntilSubscriber<H, E> {
     until(promise: Promise<any>): this;
@@ -101,7 +105,16 @@ declare class EventEmitter<H, E> {
     private subscriptions?;
     private cachedEmitSelfHandlers?;
     private cachedClassHandlers?;
+    private closed?;
     constructor(host: H);
+    /**
+     * Closes an event emitter, which will prevent any further subscriptions from being made.
+     */
+    close(): void;
+    /**
+     * @returns True if closed
+     */
+    private throwErrorIfClosed;
     raw(): IEventEmitter<H, E>;
     emitSelf<K extends keyof E>(event: K, ...args: ArgsOf<E[K]>): H;
     emit<K extends keyof E>(event: K, ...args: ArgsOf<E[K]>): H;

package/definitions/utilities/memory/ILifetime.d.ts

@@ -16,5 +16,9 @@ export declare enum ExpectedLifetime {
     /**
      * should only exist while playing the game
      */
-    WhilePlaying = 1
+    WhilePlaying = 1,
+    /**
+     * The object is expected to last until the next garbage collection system
+     */
+    UntilNextGarbageCollection = 2
 }

package/package.json

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