@novastar/taurus 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,191 @@
+import { ConnectionOptions } from "tls";
+import { Duplex } from "stream";
+import { ExtractType } from "typed-struct";
+
+//#region src/packet.d.ts
+declare const TAURUS_PACKET_FLAG = 1313822273;
+declare const TAURUS_REQUEST = 21073;
+declare const TAURUS_RESPONSE = 21072;
+declare const TAURUS_DISCOVERY = 34901;
+/**
+ * Taurus request argument.
+ *
+ * Wire layout:
+ *   action   UInt8
+ *   type     UInt8
+ *   reserved UInt16LE
+ */
+declare const TaurusRequest: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  action: number;
+  type: number;
+}, "TaurusRequest">;
+interface TaurusRequest extends ExtractType<typeof TaurusRequest, false> {}
+/**
+ * Taurus response argument.
+ *
+ * Wire layout:
+ *   status UInt16LE
+ *   action UInt8
+ *   type   UInt8
+ */
+declare const TaurusResponse: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  status: number;
+  action: number;
+  type: number;
+}, "TaurusResponse">;
+interface TaurusResponse extends ExtractType<typeof TaurusResponse, false> {}
+/**
+ * Taurus packet.
+ *
+ * The same 4 bytes are exposed as both request and response structures.
+ * packetType determines which representation should be used.
+ */
+declare const TaurusPacket: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  flag: 1313822273;
+  sequence: number;
+  packetType: 21073 | 21072 | 34901;
+  what: number;
+  readonly req: {
+    action: number;
+    type: number;
+  };
+  readonly res: {
+    status: number;
+    action: number;
+    type: number;
+  };
+  length: number;
+  encodeType: number;
+  checksum: number;
+  readonly body: Buffer<ArrayBufferLike>;
+}, "TaurusPacket">;
+interface TaurusPacket extends ExtractType<typeof TaurusPacket, false> {}
+interface TaurusCommand {
+  what: number;
+  type: number;
+  action: number;
+}
+declare const TAURUS_HEADER_SIZE: number;
+/**
+ * Calculates Taurus header checksum.
+ *
+ * The checksum is the sum of all signed 8-bit values preceding
+ * the checksum field.
+ */
+declare const calculateTaurusHeaderChecksum: (header: Uint8Array) => number;
+/**
+ * Returns the full packet size once the complete header is available.
+ */
+declare const getTaurusPacketSize: (buffer: Uint8Array) => number | undefined;
+/**
+ * Encodes a Taurus request.
+ */
+declare const encodeTaurusRequest: (sequence: number, {
+  what,
+  type,
+  action
+}: TaurusCommand, body?: string | Buffer, encodeType?: number) => Buffer;
+/** Encodes the UDP search request used by Taurus players on port 16601. */
+declare const encodeTaurusDiscoveryRequest: (supportsEncryption?: boolean) => Buffer;
+/**
+ * Decodes and validates a Taurus packet.
+ */
+declare const decodeTaurusPacket: (buffer: Uint8Array) => TaurusPacket;
+//#endregion
+//#region src/connection.d.ts
+declare class TaurusResponseError extends Error {
+  readonly status: number;
+  readonly responseBody: string;
+  constructor(status: number, responseBody: string);
+}
+declare class TaurusConnection {
+  #private;
+  readonly stream: Duplex;
+  readonly timeout: number;
+  constructor(stream: Duplex, timeout?: number);
+  get closed(): boolean;
+  request(command: TaurusCommand, body?: string | Buffer): Promise<TaurusPacket>;
+  requestJson<T>(command: TaurusCommand, body?: unknown): Promise<T>;
+  close(): void;
+}
+//#endregion
+//#region src/client.d.ts
+declare const TAURUS_MANAGEMENT_PORT = 16606;
+interface TaurusConnectOptions extends Omit<ConnectionOptions, 'host' | 'port'> {
+  host: string;
+  port?: number;
+  timeout?: number;
+  privacy?: boolean;
+}
+interface TaurusLoginOptions {
+  sn: string;
+  password: string;
+  username?: string;
+  clientId?: string;
+  clientName?: string;
+}
+interface TaurusLoginResult {
+  logined: boolean;
+  validation?: boolean;
+  validition?: boolean;
+  username?: string;
+  sn?: string;
+}
+interface TaurusBrightness {
+  brightness?: number;
+  ratio?: number;
+  solidity: boolean;
+  orderId: number;
+}
+declare class TaurusClient {
+  readonly connection: TaurusConnection;
+  private constructor();
+  static connect(options: TaurusConnectOptions): Promise<TaurusClient>;
+  login(options: TaurusLoginOptions): Promise<TaurusLoginResult>;
+  getBrightness(): Promise<TaurusBrightness>;
+  setBrightness(percent: number, persist?: boolean): Promise<void>;
+  getEnvironmentBrightness(): Promise<number>;
+  close(): void;
+}
+//#endregion
+//#region src/discovery.d.ts
+declare const TAURUS_DISCOVERY_PORT = 16601;
+interface TaurusPlayerInfo {
+  address: string;
+  aliasName: string;
+  encodeType: number;
+  height: number;
+  modelId: number;
+  platform: string;
+  privacy: boolean;
+  productName: string;
+  rotation: number;
+  sn: string;
+  tcpPort: number;
+  width: number;
+  ftpPort?: number;
+  key?: string;
+  logined?: boolean;
+  loginedUsernames?: string[];
+  syssetFtpPort?: number;
+  syssetTcpPort?: number;
+  terminalEntrancePortHttps?: number;
+  terminalEntrancePortWebSocket?: number;
+}
+declare const parseTaurusDiscoveryResponse: (message: Uint8Array, address: string) => TaurusPlayerInfo | undefined;
+declare const discoverTaurusPlayers: (destination?: string, timeout?: number) => Promise<TaurusPlayerInfo[]>;
+//#endregion
+export { TAURUS_DISCOVERY, TAURUS_DISCOVERY_PORT, TAURUS_HEADER_SIZE, TAURUS_MANAGEMENT_PORT, TAURUS_PACKET_FLAG, TAURUS_REQUEST, TAURUS_RESPONSE, TaurusBrightness, TaurusClient, TaurusCommand, TaurusConnectOptions, TaurusConnection, TaurusLoginOptions, TaurusLoginResult, TaurusPacket, TaurusPlayerInfo, TaurusRequest, TaurusResponse, TaurusResponseError, calculateTaurusHeaderChecksum, decodeTaurusPacket, discoverTaurusPlayers, encodeTaurusDiscoveryRequest, encodeTaurusRequest, getTaurusPacketSize, parseTaurusDiscoveryResponse };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,191 @@
+import { ConnectionOptions } from "tls";
+import { ExtractType } from "typed-struct";
+import { Duplex } from "stream";
+
+//#region src/packet.d.ts
+declare const TAURUS_PACKET_FLAG = 1313822273;
+declare const TAURUS_REQUEST = 21073;
+declare const TAURUS_RESPONSE = 21072;
+declare const TAURUS_DISCOVERY = 34901;
+/**
+ * Taurus request argument.
+ *
+ * Wire layout:
+ *   action   UInt8
+ *   type     UInt8
+ *   reserved UInt16LE
+ */
+declare const TaurusRequest: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  action: number;
+  type: number;
+}, "TaurusRequest">;
+interface TaurusRequest extends ExtractType<typeof TaurusRequest, false> {}
+/**
+ * Taurus response argument.
+ *
+ * Wire layout:
+ *   status UInt16LE
+ *   action UInt8
+ *   type   UInt8
+ */
+declare const TaurusResponse: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  status: number;
+  action: number;
+  type: number;
+}, "TaurusResponse">;
+interface TaurusResponse extends ExtractType<typeof TaurusResponse, false> {}
+/**
+ * Taurus packet.
+ *
+ * The same 4 bytes are exposed as both request and response structures.
+ * packetType determines which representation should be used.
+ */
+declare const TaurusPacket: import("typed-struct",{
+  with: {
+    "resolution-mode": "import"
+  }
+}).StructConstructor<{
+  flag: 1313822273;
+  sequence: number;
+  packetType: 21073 | 21072 | 34901;
+  what: number;
+  readonly req: {
+    action: number;
+    type: number;
+  };
+  readonly res: {
+    status: number;
+    action: number;
+    type: number;
+  };
+  length: number;
+  encodeType: number;
+  checksum: number;
+  readonly body: Buffer<ArrayBufferLike>;
+}, "TaurusPacket">;
+interface TaurusPacket extends ExtractType<typeof TaurusPacket, false> {}
+interface TaurusCommand {
+  what: number;
+  type: number;
+  action: number;
+}
+declare const TAURUS_HEADER_SIZE: number;
+/**
+ * Calculates Taurus header checksum.
+ *
+ * The checksum is the sum of all signed 8-bit values preceding
+ * the checksum field.
+ */
+declare const calculateTaurusHeaderChecksum: (header: Uint8Array) => number;
+/**
+ * Returns the full packet size once the complete header is available.
+ */
+declare const getTaurusPacketSize: (buffer: Uint8Array) => number | undefined;
+/**
+ * Encodes a Taurus request.
+ */
+declare const encodeTaurusRequest: (sequence: number, {
+  what,
+  type,
+  action
+}: TaurusCommand, body?: string | Buffer, encodeType?: number) => Buffer;
+/** Encodes the UDP search request used by Taurus players on port 16601. */
+declare const encodeTaurusDiscoveryRequest: (supportsEncryption?: boolean) => Buffer;
+/**
+ * Decodes and validates a Taurus packet.
+ */
+declare const decodeTaurusPacket: (buffer: Uint8Array) => TaurusPacket;
+//#endregion
+//#region src/connection.d.ts
+declare class TaurusResponseError extends Error {
+  readonly status: number;
+  readonly responseBody: string;
+  constructor(status: number, responseBody: string);
+}
+declare class TaurusConnection {
+  #private;
+  readonly stream: Duplex;
+  readonly timeout: number;
+  constructor(stream: Duplex, timeout?: number);
+  get closed(): boolean;
+  request(command: TaurusCommand, body?: string | Buffer): Promise<TaurusPacket>;
+  requestJson<T>(command: TaurusCommand, body?: unknown): Promise<T>;
+  close(): void;
+}
+//#endregion
+//#region src/client.d.ts
+declare const TAURUS_MANAGEMENT_PORT = 16606;
+interface TaurusConnectOptions extends Omit<ConnectionOptions, 'host' | 'port'> {
+  host: string;
+  port?: number;
+  timeout?: number;
+  privacy?: boolean;
+}
+interface TaurusLoginOptions {
+  sn: string;
+  password: string;
+  username?: string;
+  clientId?: string;
+  clientName?: string;
+}
+interface TaurusLoginResult {
+  logined: boolean;
+  validation?: boolean;
+  validition?: boolean;
+  username?: string;
+  sn?: string;
+}
+interface TaurusBrightness {
+  brightness?: number;
+  ratio?: number;
+  solidity: boolean;
+  orderId: number;
+}
+declare class TaurusClient {
+  readonly connection: TaurusConnection;
+  private constructor();
+  static connect(options: TaurusConnectOptions): Promise<TaurusClient>;
+  login(options: TaurusLoginOptions): Promise<TaurusLoginResult>;
+  getBrightness(): Promise<TaurusBrightness>;
+  setBrightness(percent: number, persist?: boolean): Promise<void>;
+  getEnvironmentBrightness(): Promise<number>;
+  close(): void;
+}
+//#endregion
+//#region src/discovery.d.ts
+declare const TAURUS_DISCOVERY_PORT = 16601;
+interface TaurusPlayerInfo {
+  address: string;
+  aliasName: string;
+  encodeType: number;
+  height: number;
+  modelId: number;
+  platform: string;
+  privacy: boolean;
+  productName: string;
+  rotation: number;
+  sn: string;
+  tcpPort: number;
+  width: number;
+  ftpPort?: number;
+  key?: string;
+  logined?: boolean;
+  loginedUsernames?: string[];
+  syssetFtpPort?: number;
+  syssetTcpPort?: number;
+  terminalEntrancePortHttps?: number;
+  terminalEntrancePortWebSocket?: number;
+}
+declare const parseTaurusDiscoveryResponse: (message: Uint8Array, address: string) => TaurusPlayerInfo | undefined;
+declare const discoverTaurusPlayers: (destination?: string, timeout?: number) => Promise<TaurusPlayerInfo[]>;
+//#endregion
+export { TAURUS_DISCOVERY, TAURUS_DISCOVERY_PORT, TAURUS_HEADER_SIZE, TAURUS_MANAGEMENT_PORT, TAURUS_PACKET_FLAG, TAURUS_REQUEST, TAURUS_RESPONSE, TaurusBrightness, TaurusClient, TaurusCommand, TaurusConnectOptions, TaurusConnection, TaurusLoginOptions, TaurusLoginResult, TaurusPacket, TaurusPlayerInfo, TaurusRequest, TaurusResponse, TaurusResponseError, calculateTaurusHeaderChecksum, decodeTaurusPacket, discoverTaurusPlayers, encodeTaurusDiscoveryRequest, encodeTaurusRequest, getTaurusPacketSize, parseTaurusDiscoveryResponse };
+//# sourceMappingURL=index.d.mts.map