@basmilius/apple-companion-link 0.6.6 → 0.7.0

package/dist/frame.d.ts

@@ -1,15 +1,15 @@
 export declare const FrameType: {
 	readonly Unknown: 0;
-	readonly Noop: 1;
-	readonly PS_Start: 3;
-	readonly PS_Next: 4;
-	readonly PV_Start: 5;
-	readonly PV_Next: 6;
-	readonly U_OPACK: 7;
-	readonly E_OPACK: 8;
-	readonly P_OPACK: 9;
-	readonly PA_Request: 10;
-	readonly PA_Response: 11;
+	readonly NoOp: 1;
+	readonly PairSetupStart: 3;
+	readonly PairSetupNext: 4;
+	readonly PairVerifyStart: 5;
+	readonly PairVerifyNext: 6;
+	readonly OPackUnencrypted: 7;
+	readonly OPackEncrypted: 8;
+	readonly OPackPacked: 9;
+	readonly PairingRequest: 10;
+	readonly PairingResponse: 11;
 	readonly SessionStartRequest: 16;
 	readonly SessionStartResponse: 17;
 	readonly SessionData: 18;
@@ -23,4 +23,4 @@ export declare const MessageType: {
 	readonly Response: 3;
 };
 export declare const OPackFrameTypes: number[];
-export declare const PairFrameTypes: number[];
+export declare const PairingFrameTypes: number[];

package/dist/index.js

@@ -44,16 +44,16 @@ var MediaControlCommand = {
 // src/frame.ts
 var FrameType = {
   Unknown: 0,
-  Noop: 1,
-  PS_Start: 3,
-  PS_Next: 4,
-  PV_Start: 5,
-  PV_Next: 6,
-  U_OPACK: 7,
-  E_OPACK: 8,
-  P_OPACK: 9,
-  PA_Request: 10,
-  PA_Response: 11,
+  NoOp: 1,
+  PairSetupStart: 3,
+  PairSetupNext: 4,
+  PairVerifyStart: 5,
+  PairVerifyNext: 6,
+  OPackUnencrypted: 7,
+  OPackEncrypted: 8,
+  OPackPacked: 9,
+  PairingRequest: 10,
+  PairingResponse: 11,
   SessionStartRequest: 16,
   SessionStartResponse: 17,
   SessionData: 18,
@@ -67,19 +67,19 @@ var MessageType = {
   Response: 3
 };
 var OPackFrameTypes = [
-  FrameType.PS_Start,
-  FrameType.PS_Next,
-  FrameType.PV_Start,
-  FrameType.PV_Next,
-  FrameType.U_OPACK,
-  FrameType.E_OPACK,
-  FrameType.P_OPACK
+  FrameType.PairSetupStart,
+  FrameType.PairSetupNext,
+  FrameType.PairVerifyStart,
+  FrameType.PairVerifyNext,
+  FrameType.OPackUnencrypted,
+  FrameType.OPackEncrypted,
+  FrameType.OPackPacked
 ];
-var PairFrameTypes = [
-  FrameType.PS_Start,
-  FrameType.PS_Next,
-  FrameType.PV_Start,
-  FrameType.PV_Next
+var PairingFrameTypes = [
+  FrameType.PairSetupStart,
+  FrameType.PairSetupNext,
+  FrameType.PairVerifyStart,
+  FrameType.PairVerifyNext
 ];
 
 // src/pairing.ts
@@ -108,7 +108,7 @@ class Pairing {
     return this.#internal.transient();
   }
   async#request(step, data) {
-    const frameType = step === "m1" ? FrameType.PS_Start : FrameType.PS_Next;
+    const frameType = step === "m1" ? FrameType.PairSetupStart : FrameType.PairSetupNext;
     const [, response] = await this.#stream.exchange(frameType, {
       _pd: data,
       _pwTy: 1
@@ -157,7 +157,7 @@ class Verify {
     };
   }
   async#request(step, data) {
-    const frameType = step === "m1" ? FrameType.PV_Start : FrameType.PV_Next;
+    const frameType = step === "m1" ? FrameType.PairVerifyStart : FrameType.PairVerifyNext;
     const [, response] = await this.#stream.exchange(frameType, {
       _pd: data,
       _auTy: 4
@@ -202,6 +202,7 @@ class Stream extends EncryptionAwareConnection {
   #xid;
   constructor(context, address, port) {
     super(context, address, port);
+    this.debug(true);
     this.#xid = randomInt(0, 2 ** 16);
     this.on("close", this.#onClose.bind(this));
     this.on("data", this.#onData.bind(this));
@@ -214,18 +215,15 @@ class Stream extends EncryptionAwareConnection {
   async exchange(type, obj) {
     const _x = this.#xid;
     return new Promise((resolve, reject) => {
-      if (PairFrameTypes.includes(type)) {
+      if (PairingFrameTypes.includes(type)) {
         this.#queue.set(PAIRING_QUEUE_IDENTIFIER, [resolve, reject]);
       } else {
         this.#queue.set(_x, [resolve, reject]);
       }
-      this.send(type, obj).catch(reject);
+      this.sendOPack(type, obj);
     });
   }
-  async send(type, obj) {
-    const _x = this.#xid++;
-    obj._x ??= OPack.sizedInteger(_x, 8);
-    let payload = Buffer.from(OPack.encode(obj));
+  send(type, payload) {
     let payloadLength = payload.byteLength;
     if (this.isEncrypted && payloadLength > 0) {
       payloadLength += Chacha20.CHACHA20_AUTH_TAG_LENGTH;
@@ -242,13 +240,14 @@ class Stream extends EncryptionAwareConnection {
     } else {
       data = Buffer.concat([header, payload]);
     }
-    this.context.logger.raw("[companion-link]", "Sending data frame", this.isEncrypted, Buffer.from(data).toString("hex"), obj);
-    try {
-      return await this.write(data);
-    } catch (err) {
-      this.context.logger.error("[companion-link]", "Error in Companion Link send()", err);
-      this.emit("error", err);
-    }
+    this.context.logger.raw("[companion-link]", "Sending data frame", this.isEncrypted, type);
+    this.write(data);
+  }
+  sendOPack(type, obj) {
+    const _x = this.#xid++;
+    obj._x ??= OPack.sizedInteger(_x, 8);
+    this.context.logger.raw("[companion-link]", "Sending opack frame", type, this.isEncrypted, obj);
+    this.send(type, Buffer.from(OPack.encode(obj)));
   }
   #cleanup() {
     this.#buffer = Buffer.alloc(0);
@@ -381,28 +380,28 @@ class Protocol {
     await this.#stream.disconnect();
   }
   async fetchMediaControlStatus() {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchMediaControlStatus",
       _t: MessageType.Request,
       _c: {}
     });
   }
   async fetchNowPlayingInfo() {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchCurrentNowPlayingInfoEvent",
       _t: MessageType.Request,
       _c: {}
     });
   }
   async fetchSupportedActions() {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchSupportedActionsEvent",
       _t: MessageType.Request,
       _c: {}
     });
   }
   async getAttentionState() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchAttentionState",
       _t: MessageType.Request,
       _c: {}
@@ -411,7 +410,7 @@ class Protocol {
     return convertAttentionState(_c.state);
   }
   async getLaunchableApps() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchLaunchableApplicationsEvent",
       _t: MessageType.Request,
       _c: {}
@@ -423,7 +422,7 @@ class Protocol {
     }));
   }
   async getSiriRemoteInfo() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchSiriRemoteInfo",
       _t: MessageType.Request,
       _c: {}
@@ -431,7 +430,7 @@ class Protocol {
     return Plist.parse(Buffer.from(payload["_c"]["SiriRemoteInfoKey"]).buffer);
   }
   async getUserAccounts() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "FetchUserAccountsEvent",
       _t: MessageType.Request,
       _c: {}
@@ -443,7 +442,7 @@ class Protocol {
     }));
   }
   async hidCommand(command, down = false) {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_hidC",
       _t: MessageType.Request,
       _c: {
@@ -453,7 +452,7 @@ class Protocol {
     });
   }
   async launchApp(bundleId) {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_launchApp",
       _t: MessageType.Request,
       _c: {
@@ -462,7 +461,7 @@ class Protocol {
     });
   }
   async launchUrl(url) {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_launchApp",
       _t: MessageType.Request,
       _c: {
@@ -471,7 +470,7 @@ class Protocol {
     });
   }
   async mediaControlCommand(command, content) {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_mcc",
       _t: MessageType.Request,
       _c: {
@@ -501,7 +500,7 @@ class Protocol {
     }
   }
   async switchUserAccount(accountId) {
-    await this.#stream.exchange(FrameType.E_OPACK, {
+    await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "SwitchUserAccountEvent",
       _t: MessageType.Request,
       _c: {
@@ -509,9 +508,9 @@ class Protocol {
       }
     });
   }
-  async _subscribe(event, fn) {
+  async subscribe(event, fn) {
     this.#stream.on(event, fn);
-    await this.#stream.send(FrameType.E_OPACK, {
+    this.#stream.sendOPack(FrameType.OPackEncrypted, {
       _i: "_interest",
       _t: MessageType.Event,
       _c: {
@@ -519,14 +518,14 @@ class Protocol {
       }
     });
   }
-  async _unsubscribe(event, fn) {
+  async unsubscribe(event, fn) {
     if (!this.#stream.isConnected) {
       return;
     }
     if (fn) {
       this.#stream.off(event, fn);
     }
-    await this.#stream.send(FrameType.E_OPACK, {
+    this.#stream.sendOPack(FrameType.OPackEncrypted, {
       _i: "_interest",
       _t: MessageType.Event,
       _c: {
@@ -534,8 +533,8 @@ class Protocol {
       }
     });
   }
-  async _sessionStart() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+  async sessionStart() {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_sessionStart",
       _t: MessageType.Request,
       _btHP: false,
@@ -547,8 +546,8 @@ class Protocol {
     });
     return objectOrFail(payload);
   }
-  async _systemInfo(pairingId) {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+  async systemInfo(pairingId) {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_systemInfo",
       _t: MessageType.Request,
       _btHP: false,
@@ -597,8 +596,8 @@ class Protocol {
     });
     return objectOrFail(payload);
   }
-  async _tiStart() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+  async tiStart() {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_tiStart",
       _t: MessageType.Request,
       _btHP: false,
@@ -606,8 +605,8 @@ class Protocol {
     });
     return objectOrFail(payload);
   }
-  async _touchStart() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+  async touchStart() {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "_touchStart",
       _t: MessageType.Request,
       _btHP: false,
@@ -619,8 +618,8 @@ class Protocol {
     });
     return objectOrFail(payload);
   }
-  async _tvrcSessionStart() {
-    const [, payload] = await this.#stream.exchange(FrameType.E_OPACK, {
+  async tvrcSessionStart() {
+    const [, payload] = await this.#stream.exchange(FrameType.OPackEncrypted, {
       _i: "TVRCSessionStart",
       _t: MessageType.Request,
       _btHP: false,
@@ -629,6 +628,10 @@ class Protocol {
     });
     return objectOrFail(payload);
   }
+  async noOp() {
+    this.#context.logger.debug("Sending no-op operation.");
+    await this.#stream.send(FrameType.NoOp, Buffer.allocUnsafe(0));
+  }
 }
 function objectOrFail(obj) {
   if (obj !== null && typeof obj === "object") {

package/dist/protocol.d.ts

@@ -27,11 +27,12 @@ export default class Protocol {
 	mediaControlCommand(command: MediaControlCommandKey, content?: object): Promise<object>;
 	pressButton(command: HidCommandKey, type?: ButtonPressType, holdDelayMs?: number): Promise<void>;
 	switchUserAccount(accountId: string): Promise<void>;
-	_subscribe(event: string, fn: (data: unknown) => void): Promise<void>;
-	_unsubscribe(event: string, fn?: (data: unknown) => void): Promise<void>;
-	_sessionStart(): Promise<object>;
-	_systemInfo(pairingId: Buffer): Promise<object>;
-	_tiStart(): Promise<object>;
-	_touchStart(): Promise<object>;
-	_tvrcSessionStart(): Promise<object>;
+	subscribe(event: string, fn: (data: unknown) => void): Promise<void>;
+	unsubscribe(event: string, fn?: (data: unknown) => void): Promise<void>;
+	sessionStart(): Promise<object>;
+	systemInfo(pairingId: Buffer): Promise<object>;
+	tiStart(): Promise<object>;
+	touchStart(): Promise<object>;
+	tvrcSessionStart(): Promise<object>;
+	noOp(): Promise<void>;
 }

package/dist/stream.d.ts

@@ -4,5 +4,6 @@ export default class Stream extends EncryptionAwareConnection<Record<string, [un
 	constructor(context: Context, address: string, port: number);
 	disconnect(): Promise<void>;
 	exchange(type: number, obj: Record<string, unknown>): Promise<[number, unknown]>;
-	send(type: number, obj: Record<string, unknown>): Promise<void>;
+	send(type: number, payload: Buffer): void;
+	sendOPack(type: number, obj: Record<string, unknown>): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@basmilius/apple-companion-link",
     "description": "Implementation of Apple's Companion Link in Node.js.",
-    "version": "0.6.6",
+    "version": "0.7.0",
     "type": "module",
     "license": "MIT",
     "author": {
@@ -22,7 +22,7 @@
     ],
     "publishConfig": {
         "access": "public",
-        "provenance": true
+        "provenance": false
     },
     "scripts": {
         "build": "tsgo && bun -b build.ts",
@@ -40,12 +40,12 @@
         }
     },
     "dependencies": {
-        "@basmilius/apple-common": "0.6.6",
-        "@basmilius/apple-encoding": "0.6.6",
-        "@basmilius/apple-encryption": "0.6.6"
+        "@basmilius/apple-common": "0.7.0",
+        "@basmilius/apple-encoding": "0.7.0",
+        "@basmilius/apple-encryption": "0.7.0"
     },
     "devDependencies": {
-        "@basmilius/tools": "^2.24.0",
-        "@types/bun": "^1.3.8"
+        "@basmilius/tools": "^2.25.0",
+        "@types/bun": "^1.3.9"
     }
 }