overlay-toolkit 0.9.0 → 0.10.1

package/README.md

@@ -1,4 +1,4 @@
-# Overlay Toolkit Library
-
-An API wrapper for [OverlayToolkit](https://github.com/Lotlab/ffxiv-overlay-toolkit), which is function collection extend ffxiv overlay plugin.
-
+# Overlay Toolkit Library
+
+An API wrapper for [OverlayToolkit](https://github.com/Lotlab/ffxiv-overlay-toolkit), which is function collection extend ffxiv overlay plugin.
+

package/dist/hid.d.ts

@@ -1,3 +1,4 @@
+import { IOverlayAPI } from './overlay.ts';
 export interface OverlayHID extends EventTarget {
     onconnect: ((this: this, ev: OverlayHIDConnectionEvent) => any) | null;
     ondisconnect: ((this: this, ev: OverlayHIDConnectionEvent) => any) | null;
@@ -8,7 +9,7 @@ export interface OverlayHID extends EventTarget {
     removeEventListener(type: "connect" | "disconnect", callback: (this: this, ev: OverlayHIDConnectionEvent) => any, useCapture?: boolean): void;
     removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
 }
-export declare function NewHID(): OverlayHID;
+export declare function NewHID(api: IOverlayAPI): OverlayHID;
 interface HIDDeviceInfo {
     readonly vendorId: number;
     readonly productId: number;

package/dist/main.d.ts

@@ -1,5 +1,5 @@
 import { OverlayToolkit } from './otk';
-export type { OverlayToolkit, GameVersion } from './otk';
+export { OverlayToolkit, type GameVersion } from './otk';
 export type { OverlayHID, OverlayHIDDevice, OverlayHIDConnectionEvent, OverlayHIDInputEvent } from './hid';
 export type * from './packet';
 export * from './ffxiv';

package/dist/otk.d.ts

@@ -1,3 +1,5 @@
+import { OverlayHID } from './hid';
+import { OverlayCallMessage, OverlayPluginAPI } from './overlay';
 import { PacketFilter, PacketHandler } from './packet';
 export interface DispatchMessage {
     type: string;
@@ -7,6 +9,12 @@ export interface GameVersion {
     lang: number;
 }
 export declare class OverlayToolkit {
+    /**
+     * HID interface
+     */
+    hid: OverlayHID;
+    api: OverlayPluginAPI;
+    constructor();
     /**
      * Fetch acts like window.fetch but without CORS restrictions
      * @param url target URL
@@ -29,10 +37,6 @@ export declare class OverlayToolkit {
     UnsubscribePacket(name: string): Promise<void>;
     private handlerMap;
     private packetHandler;
-    /**
-     * HID interface
-     */
-    hid: import('./hid').OverlayHID;
     /**
      * Game version
      */
@@ -107,4 +111,11 @@ export declare class OverlayToolkit {
      * @returns
      */
     IsOverlayPluginCEF(): boolean;
+    private tryConnectToCEF;
+    /**
+     * Connect to OverlayPlugin via CEF or WebSocket
+     * @param wsUrl WebSocket URL, leave empty to auto-detect from query string
+     * @returns
+     */
+    Connect(wsUrl?: string | null): void;
 }