overlay-toolkit 0.11.2 → 0.12.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/otk.d.ts

@@ -1,5 +1,6 @@
 import { OverlayHID } from './hid';
 import { OverlayCallMessage, OverlayPluginAPI } from './overlay';
+import { FileSystem } from './file_system';
 import { PacketFilter, PacketHandler } from './packet';
 export interface DispatchMessage {
     type: string;
@@ -13,15 +14,26 @@ 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
@@ -46,6 +58,11 @@ export declare class OverlayToolkit {
      * @returns get plugin version
      */
     GetPluginVersion(): Promise<string>;
+    /**
+     * Open URL in default browser
+     * @param url URL to open
+     */
+    OpenBrowser(url: string): Promise<void>;
     /**
      * Call start overlay events
      *
@@ -123,4 +140,8 @@ export declare class OverlayToolkit {
      * @returns
      */
     Connect(wsUrl?: string | null): void;
+    /**
+     * Check if connected to OverlayPlugin
+     */
+    get isConnected(): boolean;
 }