bc-stubs 121.0.0 → 122.0.0

package/bc/Assets/Female3DCG/Female3DCG.d.ts

@@ -17,6 +17,7 @@ declare namespace E {
     let Tethered: "Tethered";
     let Enclose: "Enclose";
     let MapImmobile: "MapImmobile";
+    let MapSwim: "MapSwim";
     let OneWayEnclose: "OneWayEnclose";
     let OnBed: "OnBed";
     let Lifted: "Lifted";

package/bc/NativeDeclarations/Commands.d.ts

@@ -2,7 +2,7 @@ interface ICommand {
   /** Name of the command */
   Tag: string;
   /** Description of the command */
-  Description?: string | Record<ServerChatRoomLanguage | "TW", string>;
+  Description?: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
   /** Reference to another command, used for aliases */
   Reference?: string;
   /** The function that handles the command */
@@ -17,8 +17,8 @@ interface ICommand {
   PreserveCase?: boolean;
   /** Array of commands that can be used as subcommands. */
   Subcommands?: Subcommand[];
-  /** 
-   * Array of arguments that the command accepts. 
+  /**
+   * Array of arguments that the command accepts.
    * Can be a function to generate arguments at runtime.
    * Typically used to provide additional context for users
    */
@@ -26,8 +26,8 @@ interface ICommand {
 }
 
 type ArgumentDef = {
-  name: string;
-  description: string;
+  name: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
+  description: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
   suggestions?: string[] | (() => string[]);
 };
 type Subcommand = Omit<ICommand, 'Subcommands' | 'AutoComplete'>;

package/bc/NativeDeclarations/Element.d.ts

@@ -1,5 +1,5 @@
 declare namespace ElementHelp {
-  type ElementOrId = HTMLElement | string;
+  type ElementOrId = Element | string;
   type AnchorY = 'top' | 'bottom';
   type AnchorX = 'left' | 'right';
   type AnchorXY = `${AnchorY}-${AnchorX}`;

package/bc/NativeDeclarations/Female3DCG_Types.d.ts

@@ -1050,6 +1050,10 @@ interface ExtendedItemOptionConfig {
 	PrerequisiteBuyGroup?: string;
 	/** If the option has an archetype, sets the config to use */
 	ArchetypeConfig?: null | AssetArchetypeConfig;
+	DrawOptions?: {
+		Mirror?: boolean;
+		Invert?: boolean;
+	}
 }
 
 /** Defines a single (fully parsed) extended item option */

package/bc/NativeDeclarations/KeybindingManager.d.ts

@@ -0,0 +1,131 @@
+declare namespace Keybindings {
+
+	type KeyCode = keyof typeof KeybindingManager.ASCIIKeyboardMap;
+
+	/**
+	 * Represents a combination of a physical key and optional modifier keys.
+	 *
+	 * - `key` refers to the `code` property from `KeyboardEvent`, not `key`.
+	 *   This means the value is hardware-position-based, not character-based.
+	 *   See: https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_code_values
+	 * - `modifiers` is an optional set of additional keys (Shift, Alt, Ctrl)
+	 *   that must be pressed alongside the primary key.
+	 */
+	type KeyCombo = {
+		/**
+		 * Refer to the `code` property from `KeyboardEvent`.
+		 * This means the value is hardware-position-based, not character-based.
+		 * See: https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_code_values
+		 */
+		key: KeyCode | null;
+
+		/**
+		 * An optional set of additional keys (Shift, Alt, Ctrl)
+	 	 * that must be pressed alongside the primary key.
+		 */
+		modifiers?: Set<ModifierKey>;
+	} | {
+		/**
+		 * A layout-dependent character.
+		 */
+		char: string | null;
+
+		/**
+		 * An optional set of additional keys (Shift, Alt, Ctrl)
+			 * that must be pressed alongside the primary key.
+		 */
+		modifiers?: Set<ModifierKey>;
+	};
+
+	/**
+	 * Allowed modifier keys in this keybinding system.
+	 * Uses human-readable names to match conceptual rather than platform-specific keys.
+	 */
+	type ModifierKey = "Shift" | "Alt" | "Ctrl";
+
+	/**
+	 * Unique identifier for a keybinding context.
+	 * Contexts allow the same keybinding to behave differently depending
+	 * on active UI states or modes.
+	 */
+	type ContextId = Context["id"];
+
+	/**
+	 * Groups related actions for easier navigation in a UI (e.g., "Editing", "Navigation").
+	 */
+	type Category = {
+		/** Unique identifier */
+		readonly id: "chat" | "maproom" | "navigation" | "chatroom" | "unknown";
+
+		/** User-facing label */
+		readonly name?: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
+	};
+
+	/**
+	 * Defines a context in which keybindings can be active.
+	 */
+	type Context = {
+		/** Unique identifier */
+		readonly id: "chat" | "always" | "isInChatRoom" | "isOnChatRoomScreen" | "isChatRoomCharacterMode" | "isChatRoomMapMode" | "isChatRoomChatFocused" | "isChatRoomChatNOTFocused" | "noModifiers";
+
+		/** User-facing label */
+		readonly name?: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
+
+		/** Function returning true if this context should be considered active */
+		readonly prerequisite: (event: KeyboardEvent) => boolean;
+
+		/** Optional flag whether to show this context in the UI */
+		readonly showInUI?: boolean;
+	};
+
+	/**
+	 * Represents a specific keybinding configuration for an action.
+	 */
+	type Keybinding = {
+		/** Unique identifier */
+		readonly id: string;
+
+		/** User-facing label */
+		readonly name?: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
+
+		/**
+		 * Function executed when triggered.
+		 * Returns `true` if handled, `false` otherwise.
+		 */
+		readonly action: (event: KeyboardEvent) => boolean | void;
+
+		/** Optional description */
+		readonly description?: string | Partial<Record<ServerChatRoomLanguage | "TW", string>>;
+
+		/** Contexts in which the action is valid */
+		readonly contextIds: ContextId[];
+
+		/** Currently assigned key combo */
+		keyCombo?: KeyCombo;
+
+		/** Category this action belongs to */
+		readonly categoryId: Category['id'];
+
+		/** System’s original mapping for reset purposes */
+		readonly defaultKeyCombo?: KeyCombo;
+
+		/** Flag whether the binding cannot be changed by the user */
+		readonly readonly: boolean;
+	};
+
+	type UninitializedKeybinding = {
+		id: Keybinding['id'];
+		keyCombo: KeyCombo;
+	};
+
+	/**
+	 * A lightweight, serialized form of a keybinding.
+	 */
+	type KeybindingSerialized = {
+		/** Unique identifier */
+		actionId: string;
+
+		/** String representation of the key combination. (e.g., "KeyK ⌃⇧") */
+		keyCombo: string;
+	};
+}

package/bc/NativeDeclarations/Keybindings.d.ts

@@ -0,0 +1,3 @@
+declare namespace KeybindingScreen {
+  type FilteringMode = 'action' | 'category' | 'keyCombo';
+}

package/bc/NativeDeclarations/Messages.d.ts

@@ -70,6 +70,7 @@ interface ServerAccountData extends ServerAccountImmutableData {
 	AssetFamily: "Female3DCG";
 	Infiltration?: InfiltrationType;
 	SavedColors?: HSVColor[];
+	/** @deprecated */
 	ChatSearchFilterTerms?: string;
 	Difficulty?: { Level: DifficultyLevel; LastChange: number };
 	MapData?: ChatRoomMapData;
@@ -119,6 +120,7 @@ interface ServerAccountData extends ServerAccountImmutableData {
 	FriendNames?: string;
 	SubmissivesList?: string;
 	KinkyDungeonExploredLore?: unknown[];
+	KeybindingSettings?: string;
 }
 
 // TODO: Add `Lover` after figuring out why {@link ServerPlayerSync} still passes this field to the server
@@ -177,6 +179,7 @@ type ServerAccountDataSynced = Omit<ServerAccountData, "Money" | "FriendList" |
 interface ServerOwnership {
 	MemberNumber?: number;
 	Name?: string;
+	Notes?: string;
 	Stage?: number;
 	Start?: number;
 	StartTrialOfferedByMemberNumber?: number;
@@ -249,14 +252,6 @@ type ServerChatRoomData = {
 	Game: ServerChatRoomGame;
 	Visibility: ServerChatRoomRole[];
 	Access: ServerChatRoomRole[];
-	/**
-	 * @deprecated Use {@link ServerChatRoomData.Visibility} instead, this is temporarily maintained for backwards compatibility
-	 */
-	Private: boolean; // TODO: Remove following completion of migration
-	/**
-	 * @deprecated Use {@link ServerChatRoomData.Access} instead, this is temporarily maintained for backwards compatibility
-	 */
-	Locked: boolean; // TODO: Remove following completion of migration
 	BlockCategory: ServerChatRoomBlockCategory[];
 	Language: ServerChatRoomLanguage;
 	Space: ServerChatRoomSpace;
@@ -408,11 +403,19 @@ interface ServerAccountLovershipComplete {
 
 type ServerAccountLovershipResponse = ServerAccountLovershipStatus | ServerAccountLovershipInfo | ServerAccountLovershipComplete;
 
-interface ServerAccountOwnershipRequest {
+interface ServerAccountOwnershipAcquisitionRequest {
 	MemberNumber: number;
 	Action?: "Propose" | "Accept" | "Release" | "Break";
 }
 
+interface ServerAccountOwnershipUpdateNotesRequest {
+	MemberNumber: number;
+	Action: "UpdateNotes";
+	Notes?: string;
+}
+
+type ServerAccountOwnershipRequest = ServerAccountOwnershipAcquisitionRequest | ServerAccountOwnershipUpdateNotesRequest;
+
 interface ServerAccountOwnershipStatus {
     MemberNumber: number;
     Result: "CanOfferStartTrial" | "CanStartTrial" | "CanOfferEndTrial" | "CanEndTrial";
@@ -469,6 +472,7 @@ type ChatRoomSearchSettings = {
 	MapTypes: string;
 	RoomMinSize: number;
 	RoomMaxSize: number;
+	FilterTerms: string;
 }
 
 interface ServerChatRoomSearchData {
@@ -486,14 +490,6 @@ interface ServerChatRoomSearchData {
     Space: ServerChatRoomSpace;
     Visibility: ServerChatRoomRole[];
 	Access: ServerChatRoomRole[];
-	/**
-	 * @deprecated Use {@link ServerChatRoomData.Visibility} instead, this is maintained for backwards compatibility
-	 */
-	Private?: boolean;
-	/**
-	 * @deprecated Use {@link ServerChatRoomData.Access} instead, this is maintained for backwards compatibility
-	 */
-	Locked?: boolean;
 	CanJoin: boolean;
     MapType: string;
 }

package/bc/NativeDeclarations/Title.d.ts

@@ -0,0 +1,16 @@
+// NOTE: `NPCArchetype` is for NPC's only
+type TitleName =
+	NPCArchetype | "None" | "Mistress" | "Master" | "Queen" | "King" | "Goddess" | "God" | "Mistree" | "ClubSlave" |
+	"Maid" | "HeadMaid" | "BondageMaid" | "Kidnapper" | "MasterKidnapper" | "Patient" | "PermanentPatient" |
+	"EscapedPatient" | "Nurse" | "Doctor" | "AnimeBoy" | "LadyLuck" | "LordFortune" | "Patron" | "CollegeStudent" |
+	"Nawashi" | "Houdini" | "PonyAlicorn" | "PonyPegasus" | "PonyUnicorn" | "PonyWild" | "PonyHot" | "PonyWarm" |
+	"PonyCold" | "PonyFarm" | "PonyFoal" | "InfilrationMole" | "InfilrationInfiltrator" | "InfilrationAgent" |
+	"InfilrationOperative" | "InfilrationSuperspy" | "MagicSchoolWizard" | "MagicSchoolMagus" |
+	"MagicSchoolMagician" | "MagicSchoolSorcerer" | "MagicSchoolSage" | "MagicSchoolOracle" |
+	"MagicSchoolWitch" | "MagicSchoolWarlock" | "Duchess" | "Duke" | "LittleOne" | "Baby" | "DL" |
+	"BondageBaby" | "Switch" | "Princess" |	"Prince" | "Liege" | "Majesty" | "Missy" | "Sissy" | "Tomboy" | "Femboy" | "GoodOne" |
+	"Pet" | "Dragon" |  "Vampire" | "Turtle" | "Thing" | "Elf" | "Drow" | "Pixie" | "Brat" | "Kitten" | "Puppy" | "Foxy" |
+	"Bunny" | "Doll" | "Demon" | "Angel" | "Alien" | "Captain" | "Admiral" | "Succubus" | "Incubus" | "Concubus" |
+	"GoodGirl" | "GoodBoy" | "GoodSlaveGirl" | "GoodSlaveBoy" | "GoodSlave" | "Drone" | "FreeUse" |
+	"Archbishop" | "Bishop" | "Archjudge" | "Judge" | "Champion" | "Matron" | "Patriarch" | "Primaris"
+	;