npm - overlay-toolkit - Versions diffs - 0.10.0 → 0.10.1 - Mend

overlay-toolkit 0.10.0 → 0.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/dist/ffxiv.d.ts +654 -0
package/dist/hid.d.ts +47 -0
package/dist/hid.helper.d.ts +9 -0
package/dist/main.d.ts +7 -0
package/dist/otk.d.ts +121 -0
package/dist/overlay-toolkit.js +1323 -0
package/dist/overlay-toolkit.umd.cjs +1 -0
package/dist/overlay.d.ts +46 -0
package/dist/overlay_call.d.ts +12 -0
package/dist/overlay_cef.d.ts +10 -0
package/dist/overlay_ws.d.ts +19 -0
package/dist/packet.d.ts +81 -0
package/package.json +1 -1

package/dist/overlay-toolkit.umd.cjs ADDED Viewed

@@ -0,0 +1 @@

package/dist/overlay.d.ts ADDED Viewed

@@ -0,0 +1,46 @@
+import { TypedEventTarget } from './hid.helper';
+export type OverlayTransportTarget = TypedEventTarget<{
+    message: CustomEvent<any>;
+    connected: Event;
+}>;
+export interface OverlayTransport extends EventTarget {
+    get transportType(): string;
+    get connected(): boolean;
+    sendMessage(message: any): Promise<any>;
+    addEventListener(type: "message", listener: (ev: CustomEvent<any>) => void): void;
+    addEventListener(type: "connected", listener: (ev: Event) => void): void;
+    removeEventListener(type: "message", listener: (ev: CustomEvent<any>) => void): void;
+    removeEventListener(type: "connected", listener: (ev: Event) => void): void;
+}
+export interface OverlayCallMessage {
+    call: string;
+}
+export interface OverlayEventMessage {
+    type: string;
+}
+export interface IOverlayAPI {
+    dispatchOverlayEvent(event: OverlayEventMessage): void;
+    addOverlayListener(event: string, cb: OverlayEvenetHandler): void;
+    removeOverlayListener(event: string, cb: OverlayEvenetHandler): void;
+    callOverlayHandler(msg: OverlayCallMessage): Promise<any>;
+    startOverlayEvents(): void;
+}
+export type OverlayEvenetHandler = (evt: OverlayEventMessage) => void;
+export declare class OverlayPluginAPI implements IOverlayAPI {
+    private transport;
+    private subscribers;
+    private queue;
+    setTransport(transport: OverlayTransport): void;
+    constructor(transport?: OverlayTransport | null);
+    dispatchOverlayEvent(event: OverlayEventMessage): void;
+    addOverlayListener(event: string, cb: OverlayEvenetHandler): void;
+    removeOverlayListener(event: string, cb: OverlayEvenetHandler): void;
+    callOverlayHandler(msg: OverlayCallMessage): Promise<any>;
+    /**
+     * Start overlay events
+     *
+     * Must be called after any listeners are added.
+     */
+    startOverlayEvents(): void;
+    private onTransportConnected;
+}

package/dist/overlay_call.d.ts ADDED Viewed

@@ -0,0 +1,12 @@
+import { OverlayCallMessage } from './overlay';
+export declare const getSortedPartyList: () => OverlayCallMessage;
+export declare const getFFXIVCSAddonSlow: (name: string) => OverlayCallMessage;
+export declare const getLanguage: () => OverlayCallMessage;
+export declare const getVersion: () => OverlayCallMessage;
+export declare const getCombatants: () => OverlayCallMessage;
+export declare const saveData: (key: string, data: any) => OverlayCallMessage;
+export declare const loadData: (key: string) => OverlayCallMessage;
+export declare const say: (text: string) => OverlayCallMessage;
+export declare const playSound: (file: string) => OverlayCallMessage;
+export declare const broadcast: (source: string, message: any) => OverlayCallMessage;
+export declare const openWebsiteWithWS: (url: string) => OverlayCallMessage;

package/dist/overlay_cef.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { OverlayTransport, OverlayTransportTarget } from './overlay';
+declare const OverlayPluginCefTransport_base: OverlayTransportTarget;
+export declare class OverlayPluginCefTransport extends OverlayPluginCefTransport_base implements OverlayTransport {
+    connected: boolean;
+    get transportType(): string;
+    sendMessage(message: any): Promise<any>;
+    private evtHandlerWrapper;
+    waitForApi(): void;
+}
+export {};

package/dist/overlay_ws.d.ts ADDED Viewed

@@ -0,0 +1,19 @@
+import { OverlayTransport, OverlayTransportTarget } from './overlay';
+declare const OverlayPluginWebsocketTransport_base: OverlayTransportTarget;
+export declare class OverlayPluginWebsocketTransport extends OverlayPluginWebsocketTransport_base implements OverlayTransport {
+    ws: WebSocket;
+    sequence: number;
+    responseResolvers: Map<number, (response: any) => void>;
+    evtHandler: (message: any) => void;
+    connected: boolean;
+    constructor(url: string);
+    connect(ws: WebSocket): void;
+    onError(e: Event): void;
+    onOpen(): void;
+    onMessage(ev: MessageEvent): void;
+    onClosed(ev: CloseEvent): void;
+    get transportType(): string;
+    sendMessage(message: any): Promise<any>;
+    set eventHandler(handler: (message: any) => void);
+}
+export {};

package/dist/packet.d.ts ADDED Viewed

@@ -0,0 +1,81 @@
+/**
+ * Packet filter
+ */
+export interface PacketFilter {
+    /**
+     * Packet direction, true = to server, false = to client
+     */
+    direction?: boolean;
+    /**
+     * Opcode
+     */
+    opcode?: number;
+    /**
+     * Packet length
+     */
+    length?: number;
+}
+/**
+ * Shared packet information
+ */
+export interface PacketInfo {
+    /**
+     * Event type (must be "otk::packet")
+     */
+    type: string;
+    /**
+     * Subscription name
+     */
+    name: string;
+    /**
+     * Packet direction, true = to server, false = to client
+     */
+    dir: boolean;
+    /**
+     * Connection
+     */
+    conn: string;
+    /**
+     * Packet timestamp
+     */
+    epoch: number;
+    /**
+     * Packet opcode
+     */
+    opcode: number;
+    /**
+     * Packet length
+     */
+    length: number;
+}
+/**
+ * Packet event from overlay plugin
+ */
+export interface PacketEvent extends PacketInfo {
+    /**
+     * Packet data, encoded as base64
+     */
+    msg: string;
+}
+export interface PacketSubscribeRequest {
+    call: "otk::packet";
+    action: "subscribe";
+    name: string;
+    filters: PacketFilter[];
+}
+export interface PacketSubscribeResponse {
+    name?: string;
+    error?: string;
+}
+export interface PacketUnsubscribeRequest {
+    call: "otk::packet";
+    action: "unsubscribe";
+    name: string;
+}
+export interface Packet extends PacketInfo {
+    /**
+     * Packet data
+     */
+    data: Uint8Array;
+}
+export type PacketHandler = (packet: Packet) => void;

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "overlay-toolkit",
   "private": false,
-  "version": "0.10.0",
+  "version": "0.10.1",
   "type": "module",
   "files": [
     "dist"