overlay-toolkit 0.11.3 → 0.13.0

package/dist/file_system.d.ts

@@ -0,0 +1,40 @@
+import { IOverlayAPI, OverlayCallMessage } from './overlay';
+interface CommonFilePickerOptions {
+    excludeAcceptAllOption?: boolean;
+    id?: string;
+    startIn?: "desktop" | "documents" | "downloads" | "music" | "pictures" | "videos" | string;
+    types: {
+        description?: string;
+        accept: Record<string, string[]>;
+    }[];
+}
+export interface SaveFilePickerOptions extends CommonFilePickerOptions {
+    suggestedName?: string;
+}
+export interface OpenFilePickerOptions extends CommonFilePickerOptions {
+    multiple?: boolean;
+}
+export declare const showSaveFilePicker: (options?: SaveFilePickerOptions) => OverlayCallMessage;
+export declare const showOpenFilePicker: (options?: OpenFilePickerOptions) => OverlayCallMessage;
+/**
+ * FileSystem class provides methods to interact with the file system through OverlayPlugin's API.
+ * It implements the File System Access API-like interface, allowing you to show file pickers,
+ * read files, and write files using the plugin's capabilities.
+ */
+export declare class FileSystem {
+    api: IOverlayAPI;
+    constructor(api: IOverlayAPI);
+    /**
+     * Show the save file picker dialog.
+     * @param options SaveFilePickerOptions to configure the file picker
+     * @returns A promise that resolves to a FileSystemFileHandle for the selected file
+     */
+    showSaveFilePicker(options?: SaveFilePickerOptions): Promise<FileSystemFileHandle>;
+    /**
+     * Show the open file picker dialog.
+     * @param options OpenFilePickerOptions to configure the file picker
+     * @returns A promise that resolves to an array of FileSystemFileHandle for the selected files
+     */
+    showOpenFilePicker(options?: OpenFilePickerOptions): Promise<FileSystemFileHandle[]>;
+}
+export {};

package/dist/helper.d.ts

@@ -0,0 +1,2 @@
+export declare function bufferToHex(buffer: BufferSource): string;
+export declare function hexToBuffer(str: string): Uint8Array;

package/dist/memory.d.ts

@@ -0,0 +1,49 @@
+interface SigScanData {
+    base: number;
+    addr: number;
+    bytes: string;
+    mask: boolean[];
+}
+interface MemoryReadData {
+    addr: number;
+    len: number;
+    bytes: string;
+    value?: number;
+}
+export declare class MemoryScanResult {
+    addr: number;
+    base: number;
+    bytes: Uint8Array;
+    mask: boolean[];
+    get valid(): boolean;
+    constructor(scan: SigScanData);
+    private getNthRange;
+    /**
+     * get nth masked (??) data
+     * @param index
+     * @returns data slice
+     */
+    getNthMasked(index: number): Uint8Array | null;
+    /**
+     * get nth masked (??) data in DataView
+     * @param index
+     * @returns dataview
+     */
+    getDataView(index: number): DataView | null;
+    /**
+     * get relative pointer to another object, usually LEA, call, ...
+     * @param index
+     * @returns
+     */
+    getRelativePointer(index: number): number;
+}
+export declare class MemoryReadResult {
+    addr: number;
+    length: number;
+    bytes: Uint8Array;
+    value?: number;
+    get valid(): boolean;
+    constructor(data: MemoryReadData);
+    get dataView(): DataView;
+}
+export {};

package/dist/otk.d.ts

@@ -1,6 +1,8 @@
 import { OverlayHID } from './hid';
 import { OverlayCallMessage, OverlayPluginAPI } from './overlay';
+import { FileSystem } from './file_system';
 import { PacketFilter, PacketHandler } from './packet';
+import { MemoryReadResult, MemoryScanResult } from './memory';
 export interface DispatchMessage {
     type: string;
 }
@@ -8,20 +10,41 @@ export interface GameVersion {
     version: string;
     lang: number;
 }
+export interface PluginVersion {
+    /**
+     * plugin version
+     */
+    version: string;
+    /**
+     * tools that plugin provided
+     */
+    tools?: string[];
+}
 export declare class OverlayToolkit {
     /**
      * HID interface
      */
     hid: OverlayHID;
+    fs: FileSystem;
     api: OverlayPluginAPI;
     constructor();
     /**
      * Fetch acts like window.fetch but without CORS restrictions
+     *
+     * This is old behavior for backward compatibility, new code should use fetch() instead which returns a valid Response object
      * @param url target URL
      * @param options options
      * @returns response
+     * @deprecated use fetch() instead which returns a valid Response object
      */
     Fetch(url: string, options?: RequestInit): Promise<Response>;
+    /**
+     * fetch acts like window.fetch but without CORS restrictions, returns response body as text.
+     * @param url
+     * @param options
+     * @returns
+     */
+    fetch(url: string, options?: RequestInit): Promise<Response>;
     /**
      * Subscribe to game packets
      * @param name subscription name
@@ -42,10 +65,35 @@ export declare class OverlayToolkit {
      */
     GetGameVersion(): Promise<GameVersion>;
     /**
-     * Plugin version
-     * @returns get plugin version
+     * Get plugin version
+     * @returns the plugin version
      */
     GetPluginVersion(): Promise<string>;
+    /**
+     * Get plugin version and tool list
+     * @returns the plugin info
+     */
+    GetPluginInfo(): Promise<PluginVersion>;
+    /**
+     * Open URL in default browser
+     * @param url URL to open
+     */
+    OpenBrowser(url: string): Promise<void>;
+    /**
+     * Search memory sig in program TEXT section
+     * @param sig sig to scan. e.g. "e8 ?? ?? ?? ??"
+     * @param startAddr optional. address to start search, absolute address
+     * @param offset optional. address to start search, relative to text begin
+     * @returns
+     */
+    MemoryScanSig(sig: string, offset: number, startAddr?: number): Promise<MemoryScanResult>;
+    /**
+     * Read memory with address and length
+     * @param addr address to read
+     * @param length length to read. 0x10000 maximum
+     * @returns
+     */
+    MemoryRead(addr: number, length: number): Promise<MemoryReadResult>;
     /**
      * Call start overlay events
      *
@@ -123,4 +171,8 @@ export declare class OverlayToolkit {
      * @returns
      */
     Connect(wsUrl?: string | null): void;
+    /**
+     * Check if connected to OverlayPlugin
+     */
+    get isConnected(): boolean;
 }