chore: renaming

src/__tests__/atem.spec.ts

@@ -131,7 +131,7 @@ describe('Atem', () => {
 			expect(socket.sendCommands).toHaveBeenCalledWith([cmd])
 
 			// Trigger the ack, and it should switfy resolve
-			socket.emit('commandsAck', [124])
+			socket.emit('ackPackets', [124])
 			expect(Object.keys(sentQueue)).toHaveLength(0)
 
 			// Finally, it should now resolve without a timeout

src/__tests__/connection.spec.ts

@@ -18,18 +18,18 @@ class AtemSocketChildMock implements AtemSocketChild {
 	public onDisconnect: () => Promise<void>
 	public onLog: (message: string) => Promise<void>
 	public onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>
-	public onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+	public onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 
 	constructor(
 		onDisconnect: () => Promise<void>,
 		onLog: (message: string) => Promise<void>,
 		onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>,
-		onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+		onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 	) {
 		this.onDisconnect = onDisconnect
 		this.onLog = onLog
 		this.onCommandsReceived = onCommandsReceived
-		this.onCommandsAcknowledged = onCommandsAcknowledged
+		this.onPacketsAcknowledged = onPacketsAcknowledged
 	}
 
 	public connect = jest.fn(async () => Promise.resolve())
@@ -43,9 +43,9 @@ class AtemSocketChildMock implements AtemSocketChild {
 		onDisconnect: () => Promise<void>,
 		onLog: (message: string) => Promise<void>,
 		onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>,
-		onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+		onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 	) => {
-		return new AtemSocketChildMock(onDisconnect, onLog, onCommandsReceived, onCommandsAcknowledged)
+		return new AtemSocketChildMock(onDisconnect, onLog, onCommandsReceived, onPacketsAcknowledged)
 	}
 )
 

src/atem.ts

@@ -113,11 +113,11 @@ export class BasicAtem extends EventEmitter<AtemEvents> {
 		})
 		this.dataTransferManager = new DT.DataTransferManager(this.sendCommands.bind(this))
 
-		this.socket.on('commandsReceived', (commands) => {
+		this.socket.on('receivedCommands', (commands) => {
 			this.emit('receivedCommands', commands)
 			this._mutateState(commands)
 		})
-		this.socket.on('commandsAck', (trackingIds) => this._resolveCommands(trackingIds))
+		this.socket.on('ackPackets', (trackingIds) => this._resolveCommands(trackingIds))
 		this.socket.on('info', (msg) => this.emit('info', msg))
 		this.socket.on('debug', (msg) => this.emit('debug', msg))
 		this.socket.on('error', (e) => this.emit('error', e))

src/lib/__tests__/atemSocket.spec.ts

@@ -25,7 +25,7 @@ class AtemSocketChildMock implements AtemSocketChild {
 	public onDisconnect: () => Promise<void>
 	public onLog: (message: string) => Promise<void>
 	public onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>
-	public onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+	public onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 
 	constructor() {
 		// this._debug = options.debug
@@ -35,7 +35,7 @@ class AtemSocketChildMock implements AtemSocketChild {
 		this.onDisconnect = async (): Promise<void> => Promise.resolve()
 		this.onLog = async (msg): Promise<void> => console.log(msg)
 		this.onCommandsReceived = async (): Promise<void> => Promise.resolve()
-		this.onCommandsAcknowledged = async (): Promise<void> => Promise.resolve()
+		this.onPacketsAcknowledged = async (): Promise<void> => Promise.resolve()
 	}
 
 	public connect = jest.fn(async () => Promise.resolve())
@@ -50,12 +50,12 @@ const AtemSocketChildSingleton = new AtemSocketChildMock()
 		onDisconnect: () => Promise<void>,
 		onLog: (message: string) => Promise<void>,
 		onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>,
-		onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+		onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 	) => {
 		AtemSocketChildSingleton.onDisconnect = onDisconnect
 		AtemSocketChildSingleton.onLog = onLog
 		AtemSocketChildSingleton.onCommandsReceived = onCommandsReceived
-		AtemSocketChildSingleton.onCommandsAcknowledged = onCommandsAcknowledged
+		AtemSocketChildSingleton.onPacketsAcknowledged = onPacketsAcknowledged
 		return AtemSocketChildSingleton
 	}
 )
@@ -88,7 +88,7 @@ describe('AtemSocket', () => {
 		if (!lite) {
 			AtemSocketChildSingleton.onLog = async (): Promise<void> => Promise.resolve()
 			AtemSocketChildSingleton.onDisconnect = async (): Promise<void> => Promise.resolve()
-			AtemSocketChildSingleton.onCommandsAcknowledged = async (): Promise<void> => Promise.resolve()
+			AtemSocketChildSingleton.onPacketsAcknowledged = async (): Promise<void> => Promise.resolve()
 			AtemSocketChildSingleton.onCommandsReceived = async (): Promise<void> => Promise.resolve()
 		}
 	}
@@ -328,15 +328,15 @@ describe('AtemSocket', () => {
 		const ack = jest.fn()
 
 		socket.on('disconnect', disconnect)
-		socket.on('commandsAck', ack)
+		socket.on('ackPackets', ack)
 
 		expect(AtemSocketChildSingleton.onDisconnect).toBeDefined()
 		await AtemSocketChildSingleton.onDisconnect()
 		await clock.tickAsync(0)
 		expect(disconnect).toHaveBeenCalledTimes(1)
 
-		expect(AtemSocketChildSingleton.onCommandsAcknowledged).toBeDefined()
-		await AtemSocketChildSingleton.onCommandsAcknowledged([{ packetId: 675, trackingId: 98 }])
+		expect(AtemSocketChildSingleton.onPacketsAcknowledged).toBeDefined()
+		await AtemSocketChildSingleton.onPacketsAcknowledged([{ packetId: 675, trackingId: 98 }])
 		await clock.tickAsync(0)
 		expect(ack).toHaveBeenCalledTimes(1)
 		expect(ack).toHaveBeenCalledWith([98])
@@ -354,7 +354,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		const parser = (socket as any)._commandParser as CommandParser
 		expect(parser).toBeTruthy()
@@ -383,7 +383,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		const parser = (socket as any)._commandParser as CommandParser
 		expect(parser).toBeTruthy()
@@ -420,7 +420,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		const parser = (socket as any)._commandParser as CommandParser
 		expect(parser).toBeTruthy()
@@ -479,7 +479,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		const testBuffer = Buffer.alloc(0)
 		const pktId = 822
@@ -502,7 +502,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		const testBuffer = Buffer.alloc(10, 0)
 		const pktId = 822
@@ -525,7 +525,7 @@ describe('AtemSocket', () => {
 		const change = jest.fn()
 
 		socket.on('error', error)
-		socket.on('commandsReceived', change)
+		socket.on('receivedCommands', change)
 
 		class BrokenCommand extends DeserializedCommand<{}> {
 			public static readonly rawName = 'TEST'

src/lib/__tests__/socket-child.spec.ts

@@ -32,7 +32,7 @@ function fakeConnect(child: AtemSocketChild): void {
 
 function createSocketChild(
 	onCommandsReceived?: (payload: Buffer, packetId: number) => Promise<void>,
-	onCommandsAcknowledged?: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>,
+	onPacketsAcknowledged?: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>,
 	onDisconnect?: () => Promise<void>
 ): AtemSocketChild {
 	return new AtemSocketChild(
@@ -45,7 +45,7 @@ function createSocketChild(
 		// async msg => { console.log(msg) },
 		async (): Promise<void> => Promise.resolve(),
 		onCommandsReceived || (async (): Promise<void> => Promise.resolve()),
-		onCommandsAcknowledged || (async (): Promise<void> => Promise.resolve())
+		onPacketsAcknowledged || (async (): Promise<void> => Promise.resolve())
 	)
 }
 

src/lib/atemSocket.ts

@@ -20,8 +20,8 @@ export type AtemSocketEvents = {
 	info: [string]
 	debug: [string]
 	error: [string]
-	commandsReceived: [IDeserializedCommand[]]
-	commandsAck: [number[]]
+	receivedCommands: [IDeserializedCommand[]]
+	ackPackets: [number[]]
 }
 
 export class AtemSocket extends EventEmitter<AtemSocketEvents> {
@@ -194,10 +194,10 @@ export class AtemSocket extends EventEmitter<AtemSocketEvents> {
 				}, // onCommandsReceived
 				async (ids: Array<{ packetId: number; trackingId: number }>): Promise<void> => {
 					this.emit(
-						'commandsAck',
+						'ackPackets',
 						ids.map((id) => id.trackingId)
 					)
-				}, // onCommandsAcknowledged
+				}, // onPacketsAcknowledged
 			],
 			{
 				instanceName: 'atem-connection',
@@ -260,7 +260,7 @@ export class AtemSocket extends EventEmitter<AtemSocketEvents> {
 		}
 
 		if (parsedCommands.length > 0) {
-			this.emit('commandsReceived', parsedCommands)
+			this.emit('receivedCommands', parsedCommands)
 		}
 		return parsedCommands
 	}

src/lib/atemSocketChild.ts

@@ -72,7 +72,7 @@ export class AtemSocketChild {
 	private readonly onDisconnect: () => Promise<void>
 	private readonly onLog: (message: string) => Promise<void>
 	private readonly onCommandsReceived: (payload: Buffer, packetId: number) => Promise<void>
-	private readonly onCommandsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
+	private readonly onPacketsAcknowledged: (ids: Array<{ packetId: number; trackingId: number }>) => Promise<void>
 
 	constructor(
 		options: { address: string; port: number; debugBuffers: boolean },
@@ -88,7 +88,7 @@ export class AtemSocketChild {
 		this.onDisconnect = onDisconnect
 		this.onLog = onLog
 		this.onCommandsReceived = onCommandReceived
-		this.onCommandsAcknowledged = onCommandAcknowledged
+		this.onPacketsAcknowledged = onCommandAcknowledged
 
 		this._socket = this._createSocket()
 	}
@@ -308,7 +308,7 @@ export class AtemSocketChild {
 						return true
 					}
 				})
-				ps.push(this.onCommandsAcknowledged(ackedCommands))
+				ps.push(this.onPacketsAcknowledged(ackedCommands))
 				// this.log(`${Date.now()} Got ack ${ackPacketId} Remaining=${this._inFlight.length}`)
 			}
 		}
@@ -396,7 +396,7 @@ export class AtemSocketChild {
 					// Retransmit the packet and anything after it
 					return this._retransmitFrom(sentPacket.packetId)
 				} else {
-					// A command has timed out, so we need to reset to avoid getting stuck
+					// A packet has timed out, so we need to reset to avoid getting stuck
 					this.log(`Packet timed out: ${sentPacket.packetId}`)
 					return this.restartConnection()
 				}