@sebbo2002/node-pyatv 7.3.1-develop.8 → 7.4.0-develop.1

package/dist/lib/index.d.cts

@@ -36,223 +36,6 @@ declare class FakeChildProcessController {
     end(content?: string | Record<string, unknown>): this;
 }
 
-declare enum NodePyATVExecutableType {
-    atvremote = "atvremote",
-    atvscript = "atvscript"
-}
-declare enum NodePyATVProtocol {
-    dmap = "dmap",
-    mrp = "mrp",
-    airplay = "airplay",
-    mdns = "mdns"
-}
-declare enum NodePyATVMediaType {
-    music = "music",
-    tv = "tv",
-    video = "video",
-    unknown = "unknown"
-}
-declare enum NodePyATVDeviceState {
-    idle = "idle",
-    loading = "loading",
-    paused = "paused",
-    playing = "playing",
-    seeking = "seeking",
-    stopped = "stopped"
-}
-declare enum NodePyATVRepeatState {
-    all = "all",
-    track = "track",
-    off = "off"
-}
-declare enum NodePyATVShuffleState {
-    albums = "albums",
-    songs = "songs",
-    off = "off"
-}
-declare enum NodePyATVPowerState {
-    on = "on",
-    off = "off"
-}
-declare enum NodePyATVFocusState {
-    focued = "focused",
-    focused = "focused",
-    unfocused = "unfocused"
-}
-declare enum NodePyATVKeys {
-    down = "down",
-    home = "home",
-    homeHold = "homeHold",
-    left = "left",
-    menu = "menu",
-    next = "next",
-    pause = "pause",
-    play = "play",
-    playPause = "playPause",
-    previous = "previous",
-    right = "right",
-    select = "select",
-    skipBackward = "skipBackward",
-    skipForward = "skipForward",
-    stop = "stop",
-    suspend = "suspend",
-    topMenu = "topMenu",
-    up = "up",
-    volumeDown = "volumeDown",
-    volumeUp = "volumeUp",
-    wakeup = "wakeup",
-    turnOff = "turnOff",
-    turnOn = "turnOn"
-}
-declare enum NodePyATVListenerState {
-    stopped = 0,
-    starting = 1,
-    started = 2,
-    stopping = 3
-}
-type NodePyATVStateIndex = keyof NodePyATVState;
-type NodePyATVEventValueType = (string | number | NodePyATVMediaType | NodePyATVDeviceState | NodePyATVShuffleState | NodePyATVRepeatState);
-interface NodePyATVInstanceOptions {
-    atvremotePath?: string;
-    atvscriptPath?: string;
-    debug?: true | ((msg: string) => void);
-    noColors?: true;
-    spawn?: (command: string, args: Array<string>, options: SpawnOptions) => (ChildProcess | FakeChildProcess);
-}
-interface NodePyATVVersionResponse {
-    pyatv: string | null;
-    module: string | null;
-}
-interface NodePyATVFindOptions {
-    host?: string;
-    hosts?: string[];
-    id?: string;
-    protocol?: NodePyATVProtocol;
-    dmapCredentials?: string;
-    mrpCredentials?: string;
-    airplayCredentials?: string;
-    companionCredentials?: string;
-    raopCredentials?: string;
-}
-interface NodePyATVFindAndInstanceOptions extends NodePyATVInstanceOptions, NodePyATVFindOptions {
-}
-interface NodePyATVDeviceOptions extends NodePyATVFindAndInstanceOptions {
-    host: string;
-    name: string;
-    mac?: string;
-    model?: string;
-    modelName?: string;
-    os?: string;
-    version?: string;
-    services?: NodePyATVService[];
-    allIDs?: string[];
-}
-interface NodePyATVGetStateOptions {
-    maxAge?: number;
-}
-interface NodePyATVService {
-    protocol: NodePyATVProtocol;
-    port: number;
-}
-interface NodePyATVState {
-    dateTime: Date | null;
-    hash: string | null;
-    mediaType: NodePyATVMediaType | null;
-    deviceState: NodePyATVDeviceState | null;
-    title: string | null;
-    artist: string | null;
-    album: string | null;
-    genre: string | null;
-    totalTime: number | null;
-    position: number | null;
-    shuffle: NodePyATVShuffleState | null;
-    repeat: NodePyATVRepeatState | null;
-    app: string | null;
-    appId: string | null;
-    powerState: NodePyATVPowerState | null;
-    volume: number | null;
-    focusState: NodePyATVFocusState | null;
-    outputDevices: Array<{
-        name: string;
-        identifier: string;
-    }> | null;
-}
-interface NodePyATVApp {
-    id: string;
-    name: string;
-    launch: () => Promise<void>;
-}
-
-declare class NodePyATVDeviceEvent {
-    protected readonly values: {
-        key: NodePyATVStateIndex;
-        old: NodePyATVEventValueType;
-        new: NodePyATVEventValueType;
-        device: NodePyATVDevice;
-    };
-    /**
-     *
-     * @param values
-     * @internal
-     */
-    constructor(values: {
-        key: NodePyATVStateIndex;
-        old: NodePyATVEventValueType;
-        new: NodePyATVEventValueType;
-        device: NodePyATVDevice;
-    });
-    /**
-     * References the attribute name which was changed. So if the
-     * title has been updated, this would be `title`.
-     */
-    get key(): NodePyATVStateIndex;
-    /**
-     * Holds the old value which was there
-     * before the value was changed.
-     */
-    get oldValue(): NodePyATVEventValueType;
-    /**
-     * @alias value
-     */
-    get newValue(): NodePyATVEventValueType;
-    /**
-     * New, current value for `key`
-     */
-    get value(): NodePyATVEventValueType;
-    /**
-     * References the device instance this
-     * event originates from
-     */
-    get device(): NodePyATVDevice;
-}
-
-/**
- * @internal
- */
-declare class NodePyATVDeviceEvents extends EventEmitter {
-    private readonly options;
-    private readonly state;
-    private readonly device;
-    private pyatv;
-    private timeout;
-    private listenerState;
-    constructor(state: NodePyATVState, device: NodePyATVDevice, options: NodePyATVDeviceOptions);
-    applyStateAndEmitEvents(newState: NodePyATVState): void;
-    private parsePushUpdate;
-    private applyPushUpdate;
-    private checkListener;
-    private startListening;
-    protected stopListening(reqId: string): Promise<void>;
-    addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    on(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    once(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    prependListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    removeAllListeners(event?: string | symbol): this;
-    removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
-    listenerCount(event?: string | symbol): number;
-}
-
 /**
  * Represents an Apple TV. Use [[getState]] to query the current state (e.g. media
  * type and title). You can also use the attribute methods (e.g. [[getTitle]] to get
@@ -484,7 +267,8 @@ declare class NodePyATVDevice implements EventEmitter {
      * see https://pyatv.dev/documentation/atvremote/#apps for more details.
      */
     listApps(): Promise<NodePyATVApp[]>;
-    private _pressKey;
+    private _pressKeyWithScript;
+    private _pressKeyWithRemote;
     /**
      * Send a key press to the Apple TV
      *
@@ -730,6 +514,227 @@ declare class NodePyATVDevice implements EventEmitter {
     setMaxListeners(n: number): this;
 }
 
+declare enum NodePyATVExecutableType {
+    atvremote = "atvremote",
+    atvscript = "atvscript"
+}
+declare enum NodePyATVProtocol {
+    dmap = "dmap",
+    mrp = "mrp",
+    airplay = "airplay",
+    mdns = "mdns"
+}
+declare enum NodePyATVMediaType {
+    music = "music",
+    tv = "tv",
+    video = "video",
+    unknown = "unknown"
+}
+declare enum NodePyATVDeviceState {
+    idle = "idle",
+    loading = "loading",
+    paused = "paused",
+    playing = "playing",
+    seeking = "seeking",
+    stopped = "stopped"
+}
+declare enum NodePyATVRepeatState {
+    all = "all",
+    track = "track",
+    off = "off"
+}
+declare enum NodePyATVShuffleState {
+    albums = "albums",
+    songs = "songs",
+    off = "off"
+}
+declare enum NodePyATVPowerState {
+    on = "on",
+    off = "off"
+}
+declare enum NodePyATVFocusState {
+    focued = "focused",
+    focused = "focused",
+    unfocused = "unfocused"
+}
+declare enum NodePyATVKeys {
+    down = "down",
+    home = "home",
+    homeHold = "homeHold",
+    left = "left",
+    menu = "menu",
+    next = "next",
+    pause = "pause",
+    play = "play",
+    playPause = "playPause",
+    previous = "previous",
+    right = "right",
+    select = "select",
+    skipBackward = "skipBackward",
+    skipForward = "skipForward",
+    stop = "stop",
+    suspend = "suspend",
+    topMenu = "topMenu",
+    up = "up",
+    volumeDown = "volumeDown",
+    volumeUp = "volumeUp",
+    wakeup = "wakeup",
+    turnOff = "turnOff",
+    turnOn = "turnOn"
+}
+declare enum NodePyATVListenerState {
+    stopped = 0,
+    starting = 1,
+    started = 2,
+    stopping = 3
+}
+type NodePyATVStateIndex = keyof NodePyATVState;
+type NodePyATVEventValueType = (string | number | NodePyATVMediaType | NodePyATVDeviceState | NodePyATVShuffleState | NodePyATVRepeatState);
+interface NodePyATVInstanceOptions {
+    atvremotePath?: string;
+    atvscriptPath?: string;
+    debug?: true | ((msg: string) => void);
+    noColors?: true;
+    spawn?: (command: string, args: Array<string>, options: SpawnOptions) => (ChildProcess | FakeChildProcess);
+}
+interface NodePyATVVersionResponse {
+    pyatv: string | null;
+    module: string | null;
+}
+interface NodePyATVFindOptions {
+    host?: string;
+    hosts?: string[];
+    id?: string;
+    protocol?: NodePyATVProtocol;
+    dmapCredentials?: string;
+    mrpCredentials?: string;
+    airplayCredentials?: string;
+    companionCredentials?: string;
+    raopCredentials?: string;
+}
+interface NodePyATVFindAndInstanceOptions extends NodePyATVInstanceOptions, NodePyATVFindOptions {
+}
+interface NodePyATVFindResponseObject {
+    devices: NodePyATVDevice[];
+    errors: Record<string, unknown>[];
+}
+interface NodePyATVDeviceOptions extends NodePyATVFindAndInstanceOptions {
+    host: string;
+    name: string;
+    mac?: string;
+    model?: string;
+    modelName?: string;
+    os?: string;
+    version?: string;
+    services?: NodePyATVService[];
+    allIDs?: string[];
+}
+interface NodePyATVGetStateOptions {
+    maxAge?: number;
+}
+interface NodePyATVService {
+    protocol: NodePyATVProtocol;
+    port: number;
+}
+interface NodePyATVState {
+    dateTime: Date | null;
+    hash: string | null;
+    mediaType: NodePyATVMediaType | null;
+    deviceState: NodePyATVDeviceState | null;
+    title: string | null;
+    artist: string | null;
+    album: string | null;
+    genre: string | null;
+    totalTime: number | null;
+    position: number | null;
+    shuffle: NodePyATVShuffleState | null;
+    repeat: NodePyATVRepeatState | null;
+    app: string | null;
+    appId: string | null;
+    powerState: NodePyATVPowerState | null;
+    volume: number | null;
+    focusState: NodePyATVFocusState | null;
+    outputDevices: Array<{
+        name: string;
+        identifier: string;
+    }> | null;
+}
+interface NodePyATVApp {
+    id: string;
+    name: string;
+    launch: () => Promise<void>;
+}
+
+declare class NodePyATVDeviceEvent {
+    protected readonly values: {
+        key: NodePyATVStateIndex;
+        old: NodePyATVEventValueType;
+        new: NodePyATVEventValueType;
+        device: NodePyATVDevice;
+    };
+    /**
+     *
+     * @param values
+     * @internal
+     */
+    constructor(values: {
+        key: NodePyATVStateIndex;
+        old: NodePyATVEventValueType;
+        new: NodePyATVEventValueType;
+        device: NodePyATVDevice;
+    });
+    /**
+     * References the attribute name which was changed. So if the
+     * title has been updated, this would be `title`.
+     */
+    get key(): NodePyATVStateIndex;
+    /**
+     * Holds the old value which was there
+     * before the value was changed.
+     */
+    get oldValue(): NodePyATVEventValueType;
+    /**
+     * @alias value
+     */
+    get newValue(): NodePyATVEventValueType;
+    /**
+     * New, current value for `key`
+     */
+    get value(): NodePyATVEventValueType;
+    /**
+     * References the device instance this
+     * event originates from
+     */
+    get device(): NodePyATVDevice;
+}
+
+/**
+ * @internal
+ */
+declare class NodePyATVDeviceEvents extends EventEmitter {
+    private readonly options;
+    private readonly state;
+    private readonly device;
+    private pyatv;
+    private timeout;
+    private listenerState;
+    constructor(state: NodePyATVState, device: NodePyATVDevice, options: NodePyATVDeviceOptions);
+    applyStateAndEmitEvents(newState: NodePyATVState): void;
+    private parsePushUpdate;
+    private applyPushUpdate;
+    private checkListener;
+    private startListening;
+    protected stopListening(reqId: string): Promise<void>;
+    addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    on(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    once(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    prependListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    removeAllListeners(event?: string | symbol): this;
+    removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this;
+    listenerCount(event?: string | symbol): number;
+}
+
 /**
  * Default class exported by `@sebbo2002/node-pyatv`. Use [[find]] to scan for devices in your local network. Use
  * [[device]] to connect to a known device by passing (at least) it's name and IP.
@@ -765,9 +770,19 @@ declare class NodePyATVInstance {
      * console.log(devices);
      * ```
      *
+     * Normally `node-pyatv` ignores error messages if at least one device has been found, but if you
+     * always want to receive the error messages, you can set the second argument to `true`:
+     *
+     * ```typescript
+     * const result = await pyatv.find({}, true);
+     * console.log(result.devices);
+     * console.log(result.errors);
+     * ```
+     *
      * @param options
      */
     static find(options?: NodePyATVFindAndInstanceOptions): Promise<NodePyATVDevice[]>;
+    static find(options: NodePyATVFindAndInstanceOptions, returnDevicesAndErrors: true): Promise<NodePyATVFindResponseObject>;
     /**
      * Create a [[NodePyATVDevice]] to query the state and control it.
      * At least `host` and `name` are required.