@hotbunny/hackhub-content-sdk 0.9.4 → 0.9.5

package/README.md

@@ -39,13 +39,18 @@ export default class MyMod extends Bootstrap {
 
 ## Quests
 
-Quests use `CreateData()` to initialize data once when the quest is first claimed. After that, access the data via `this.Data`:
+Quests use a generic type parameter for type-safe data. `CreateData()` initializes the data once when the quest is first claimed. After that, access via `this.Data` and update via `this.SetData()`:
 
 ```typescript
 import { Quest, Events, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
 
+interface InfiltrationData {
+    targetIp: string;
+    attempts: number;
+}
+
 @RegisterQuest
-class InfiltrationQuest extends Quest {
+class InfiltrationQuest extends Quest<InfiltrationData> {
     Name = "Infiltration";
     Title = "Server Infiltration";
     Description = "Hack into the target server and download the data.";
@@ -60,15 +65,16 @@ class InfiltrationQuest extends Quest {
         },
     ];
 
-    CreateData() {
+    CreateData(): InfiltrationData {
         return {
             targetIp: Network.randomIp(),
+            attempts: 0,
         };
     }
 
     OnStart() {
         Network.createSubnetNetwork({
-            ip: this.Data.targetIp,
+            ip: this.Data.targetIp,   // fully typed
             type: "ROUTER",
             ports: [{ external: 22, internal: 22, active: true, service: "ssh" }],
             users: [Network.createUser({ username: "admin", password: "secret123" })],
@@ -76,7 +82,10 @@ class InfiltrationQuest extends Quest {
         });
 
         Events.on("Terminal.NmapScan", (data) => {
-            if (data.ip === this.Data.targetIp) this.completeObjective("scan");
+            if (data.ip === this.Data.targetIp) {
+                this.SetData("attempts", this.Data.attempts + 1);  // type-safe key & value
+                this.completeObjective("scan");
+            }
         });
 
         Events.on("Terminal.SSH.Connected", (data) => {
@@ -96,11 +105,15 @@ Quests can send in-game emails and start phone call dialogs:
 
 ```typescript
 @RegisterQuest
-class StoryQuest extends Quest {
+class StoryQuest extends Quest<{ contacted: boolean }> {
     Name = "StoryQuest";
     Title = "Story Quest";
     Objectives = [{ name: "start", description: "Begin the mission" }];
 
+    CreateData() {
+        return { contacted: false };
+    }
+
     Mails = [
         { title: "Mission Briefing", content: "Your target is ready. Good luck." },
     ];

package/index.d.ts

@@ -1078,31 +1078,32 @@ export declare abstract class Bootstrap {
 	OnModPackageUnloaded(): void;
 }
 /**
- * Base class for mod quests. Mod authors extend this to create custom quests.
+ * Base class for mod quests. Extend with a generic type for type-safe quest data.
  *
  * @example
  * ```ts
- * import { Quest, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+ * interface MyData { targetIp: string; attempts: number; }
  *
  * @RegisterQuest
- * export class HackThePlanet extends Quest {
+ * export class HackThePlanet extends Quest<MyData> {
  *     Name = "HackThePlanet";
  *     Title = "Hack the Planet";
- *     Rewards = { money: 5000 };
  *     Objectives = [
  *         { name: "scan", description: "Scan the target with nmap" },
- *         { name: "exploit", description: "Exploit the vulnerability", unlocksAfter: ["scan"] },
  *     ];
  *
+ *     CreateData() {
+ *         return { targetIp: "192.168.1.50", attempts: 0 };
+ *     }
+ *
  *     OnStart() {
- *         Events.on("Terminal.NmapScan", (data) => {
- *             if (data.ip === "192.168.1.50") this.completeObjective("scan");
- *         });
+ *         console.log(this.Data.targetIp); // fully typed
+ *         this.SetData("attempts", 1);     // type-safe key & value
  *     }
  * }
  * ```
  */
-export declare abstract class Quest {
+export declare abstract class Quest<T extends Record<string, any> = Record<string, any>> {
 	abstract Name: string;
 	abstract Title: string;
 	abstract Objectives: QuestObjectiveDefinition[];
@@ -1130,7 +1131,7 @@ export declare abstract class Quest {
 	/** Phone-call dialog tree for this quest. Use this.createDialog(branch) to start. */
 	Dialog?: QuestDialogDefinition;
 	/** Quest data created by CreateData(). Populated at runtime by the game engine. */
-	Data: any;
+	Data: T;
 	/**
 	 * Called when the quest is first claimed/started.
 	 * Use this to set up event listeners for objective completion.
@@ -1143,15 +1144,19 @@ export declare abstract class Quest {
 	/** Called when the quest's objectives listener starts (e.g. after game load). */
 	OnObjectivesStart(): void;
 	/** Return initial quest data. Override to provide custom data storage. */
-	CreateData(): any;
+	CreateData(): T;
+	/** Update a single key in the quest data and persist it. */
+	SetData<K extends keyof T>(key: K, value: T[K]): void;
 	/** Complete an objective by its name. */
 	completeObjective(name: string): void;
 	/** Send a mail from the Mails array by index. */
 	sendMail(index: number, from?: string, to?: string): void;
 	/** Start a phone-call dialog. Defaults to "default" branch. */
 	createDialog(branch?: string, startIndex?: number): void;
+	/** @internal */ _completeObjectiveInternal?: (index: number) => void;
 	/** @internal */ _sendMailInternal?: (index: number, from?: string, to?: string) => void;
 	/** @internal */ _createDialogInternal?: (branch: string, startIndex: number) => void;
+	/** @internal */ _saveDataInternal?: () => void;
 }
 /**
  * Base class for mod websites. Mod authors extend this to create

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.4",
+    "version": "0.9.5",
     "description": "Official modding SDK for HackHub - Ultimate Hacker Simulator on Steam. Create custom quests, websites, terminal commands, and desktop apps.",
     "types": "index.d.ts",
     "exports": {