@hotbunny/hackhub-content-sdk 0.2.0 → 0.4.0

package/index.d.ts

@@ -68,6 +68,10 @@ export interface CommandDefinition {
 	packageName?: string;
 	autocomplete?: CommandAutoComplete[];
 }
+export interface ParsedFlags {
+	flags: Record<string, string | boolean>;
+	positional: string[];
+}
 export interface CommandTools {
 	println(text: string): void;
 	printError(text: string): void;
@@ -80,11 +84,29 @@ export interface CommandTools {
 	isLocked(): boolean;
 	lock(): void;
 	unlock(): void;
+	/** Print a formatted ASCII table. */
+	printTable(headers: string[], rows: string[][]): void;
+	/** Print a success message (green). */
+	printSuccess(text: string): void;
+	/** Print a warning message (yellow). */
+	printWarning(text: string): void;
+	/** Print an info message (cyan). */
+	printInfo(text: string): void;
+	/** Parse args into flags and positional arguments. */
+	parseFlags(): ParsedFlags;
 }
 export interface AppSize {
 	width: number;
 	height: number;
 }
+/** App Store listing definition for mod apps. */
+export interface AppStoreDefinition {
+	title: string;
+	ratings: number;
+	description: string;
+	/** Price in dollars. Omit for free apps. */
+	price?: number;
+}
 export interface AppDefinition {
 	name: string;
 	title: string;
@@ -96,12 +118,67 @@ export interface AppDefinition {
 	maxOpen?: number;
 	disableMaximize?: boolean;
 	disableMinimize?: boolean;
-	store?: {
-		title: string;
-		ratings: number;
-		description: string;
-		price?: number;
-	};
+	store?: AppStoreDefinition;
+}
+/** Twotter account that gets registered with the game for quest use. */
+export interface TwotterAccountDefinition {
+	id: string;
+	username: string;
+	displayName: string;
+	avatar: string;
+	bio?: string;
+	followers?: number;
+	following?: number;
+	verified?: boolean;
+}
+/** A tweet posted by a Twotter account during a quest. */
+export interface TweetDefinition {
+	/** Must match a TwotterAccountDefinition.id from TwotterAccounts. */
+	accountId: string;
+	content: string;
+	image?: string;
+	likes?: number;
+	comments?: number;
+	shares?: number;
+	views?: number;
+	/** How long ago the tweet was posted, e.g. "2 days", "1 month". */
+	postedAgo?: string;
+}
+/** A Kisscord conversation chain attached to a quest. */
+export interface KisscordChatDefinition {
+	/** The Kisscord user ID to chat with (NPC). */
+	contactId: string;
+	/** Ordered list of messages. The chain follows array order automatically. */
+	messages: KisscordMessageDefinition[];
+}
+/** A single Kisscord message in a chat chain. */
+export interface KisscordMessageDefinition {
+	content: string;
+	/** True if the player sends this message. Defaults to false (NPC). */
+	isMine?: boolean;
+	/** Delay in ms before this NPC message appears. */
+	delayMs?: number;
+	/** Callback fired after this message is sent/received. */
+	onSent?: () => void | Promise<void>;
+}
+/** A WeeChat (IRC) conversation chain attached to a quest. */
+export interface WeeChatChatDefinition {
+	/** The IRC server host. */
+	host: string;
+	/** Ordered list of messages. */
+	messages: WeeChatMessageDefinition[];
+}
+/** A single WeeChat message in a chain. */
+export interface WeeChatMessageDefinition {
+	content: string;
+	/** Username for NPC messages. Player username auto-filled if isMine. */
+	username?: string;
+	/** True if the player sends this message. */
+	isMine?: boolean;
+	/** Delay in ms before this NPC message appears. */
+	delayMs?: number;
+	/** Callback fired after this message is sent. */
+	onSent?: () => void | Promise<void>;
 }
 /**
  * Game events that mods can listen to.
@@ -809,6 +886,14 @@ export declare abstract class Quest {
 	MaxClaimPerDay?: number;
 	Abandonable?: boolean;
 	HasCompleteButton?: boolean;
+	/** Twotter accounts to register when this quest loads. */
+	TwotterAccounts?: TwotterAccountDefinition[];
+	/** Tweets to post when the quest starts. */
+	Tweets?: TweetDefinition[];
+	/** Kisscord chat chains for this quest. */
+	KisscordChats?: KisscordChatDefinition[];
+	/** WeeChat (IRC) chat chains for this quest. */
+	WeeChatChats?: WeeChatChatDefinition[];
 	/**
 	 * Called when the quest is first claimed/started.
 	 * Use this to set up event listeners for objective completion.
@@ -846,8 +931,25 @@ export declare abstract class Quest {
  *         { path: "/", title: "Home", html: homePage },
  *         { path: "/about", title: "About", html: aboutPage },
  *     ];
+ *     Exports = {
+ *         formatPost: (text: string) => text.toUpperCase(),
+ *     };
  * }
  * ```
+ *
+ * In your HTML, access exported functions via `window.ModExports`:
+ * ```html
+ * <script>
+ *   const formatted = window.ModExports.formatPost("hello");
+ * </script>
+ * ```
+ *
+ * SDK APIs are available via `window.HackhubSDK`:
+ * ```html
+ * <script>
+ *   window.HackhubSDK.Mail.send({ to: "user@mail.com", subject: "Hi" });
+ * </script>
+ * ```
  */
 export declare abstract class Website {
 	abstract SiteName: string;
@@ -855,6 +957,11 @@ export declare abstract class Website {
 	abstract Icon: string;
 	abstract Pages: WebsitePageDefinition[];
 	Popular?: boolean;
+	/**
+	 * Functions/values exposed to all pages' HTML via `window.ModExports`.
+	 * Use this to bridge your TypeScript logic with the iframe UI.
+	 */
+	Exports?: Record<string, any>;
 }
 /**
  * Base class for mod terminal commands. Mod authors extend this to
@@ -917,8 +1024,26 @@ export declare abstract class Command {
  *         ratings: 4.5,
  *         description: "Generate secure passwords",
  *     };
+ *     Exports = {
+ *         generate: (length: number) => "x".repeat(length),
+ *     };
  * }
  * ```
+ *
+ * In your HTML, access exported functions via `window.ModExports`:
+ * ```html
+ * <script>
+ *   const pw = window.ModExports.generate(16);
+ *   document.getElementById("result").textContent = pw;
+ * </script>
+ * ```
+ *
+ * SDK APIs are available via `window.HackhubSDK`:
+ * ```html
+ * <script>
+ *   window.HackhubSDK.Events.emit("PasswordGenerated");
+ * </script>
+ * ```
  */
 export declare abstract class App {
 	abstract AppName: string;
@@ -931,12 +1056,15 @@ export declare abstract class App {
 	MaxOpen?: number;
 	DisableMaximize?: boolean;
 	DisableMinimize?: boolean;
-	Store?: {
-		title: string;
-		ratings: number;
-		description: string;
-		price?: number;
-	};
+	/** App Store listing. If provided, the app appears in the AppStore. */
+	Store?: AppStoreDefinition;
+	/** If true, the app is unlocked in the AppStore by default (no quest required). */
+	Unlocked?: boolean;
+	/**
+	 * Functions/values exposed to the app's HTML via `window.ModExports`.
+	 * Use this to bridge your TypeScript logic with the iframe UI.
+	 */
+	Exports?: Record<string, any>;
 }
 /**
  * Game events API. Allows mods to listen to in-game events
@@ -1314,6 +1442,26 @@ export declare namespace Shell {
 	export function getInstalledPackages(): string[];
 	/** Check if a specific package is installed. */
 	export function isPackageInstalled(pkg: string): boolean;
+	/**
+	 * Add response data for a built-in terminal command.
+	 * When a player runs `command input`, the game returns this data.
+	 *
+	 * @example
+	 * ```ts
+	 * Shell.addCommandData("nmap", "10.0.0.1", [
+	 *     { port: 22, service: "ssh", status: "OPEN", version: "OpenSSH 8.9" }
+	 * ]);
+	 * Shell.addCommandData("whois", "example.com", { registrant: "John Doe" });
+	 * ```
+	 */
+	export function addCommandData(command: string, input: any, data: any): void;
+	/**
+	 * Remove previously added command data.
+	 * Should be called when a quest completes to clean up.
+	 */
+	export function removeCommandData(command: string, input: any): void;
+	/** Get existing command data for a command+input pair. */
+	export function getCommandData(command: string, input: any): any;
 	export {};
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.2.0",
+    "version": "0.4.0",
     "description": "Type definitions and API reference for HackHub mod development",
     "types": "index.d.ts",
     "files": [