@springfield/ham-radio-utils 3.2.5 → 4.0.0

package/dist/utils/ui-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"ui-logger.js","sourceRoot":"","sources":["../../src/utils/ui-logger.ts"],"names":[],"mappings":"AAiCA;;GAEG;AACH,MAAM,cAAc,GAAG,CAAC,GAAY,EAAkC,EAAE,CACtE,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,aAAa,IAAI,GAAG,IAAI,OAAQ,GAA+B,CAAC,WAAW,KAAK,QAAQ,CAAC;AAEtI,MAAM,UAAU,GAAG,CAAC,GAAY,EAA+B,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,SAAS,IAAI,GAAG,CAAC;AAE9H,MAAM,WAAW,GAAG,CAAC,GAAY,EAA6C,EAAE,CAC9E,OAAO,GAAG,KAAK,QAAQ;IACvB,GAAG,KAAK,IAAI;IACZ,UAAU,IAAI,GAAG;IACjB,OAAQ,GAA+B,CAAC,QAAQ,KAAK,QAAQ;IAC5D,GAA+B,CAAC,QAAQ,KAAK,IAAI;IAClD,SAAS,IAAM,GAA+B,CAAC,QAAoC,CAAC;AAEtF,MAAM,aAAa,GAAG,CAAC,GAAY,EAA+C,EAAE,CAClF,OAAO,GAAG,KAAK,QAAQ;IACvB,GAAG,KAAK,IAAI;IACZ,YAAY,IAAI,GAAG;IACnB,OAAQ,GAA+B,CAAC,UAAU,KAAK,QAAQ;IAC9D,GAA+B,CAAC,UAAU,KAAK,IAAI;IACpD,SAAS,IAAM,GAA+B,CAAC,UAAsC,CAAC;AAExF;;GAEG;AACH,MAAM,OAAO,QAAQ;IACX,MAAM,CAAY;IAClB,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEtD,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,sCAAsC;IACtC,YAAY,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB;QACzF,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAEjD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,SAAS;YACT,WAAW;YACX,WAAW;YACX,SAAS;YACT,SAAS;YACT,SAAS;YACT,UAAU;SACX,CAAC;aACD,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,sCAAsC;IACtC,iBAAiB,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB,EAAE,OAAwB;QACxH,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,8CAA8C;QAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACpF,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEhD,sDAAsD;QACtD,MAAM,UAAU,GAAG,WAAW,KAAK,aAAa,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAExH,uEAAuE;QACvE,iDAAiD;QACjD,MAAM,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,QAAsB,CAAC,CAAC;QACrE,iDAAiD;QACjD,MAAM,iBAAiB,GAAG,YAAY,IAAI,KAAK,CAAC,IAAI,CAAC,YAA0B,CAAC,CAAC;QAEjF,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,WAAW;YACX,UAAU;YACV,YAAY;YACZ,YAAY,EAAE,iBAAiB;YAC/B,QAAQ,EAAE,aAAa;YACvB,WAAW;YACX,QAAQ;YACR,OAAO;YACP,SAAS;YACT,SAAS;YACT,SAAS;YACT,OAAO,EAAE,IAAI;YACb,UAAU;SACX,CAAC;aACD,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAC5C,CAAC;IAED,sCAAsC;IACtC,iBAAiB,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB,EAAE,KAAY,EAAE,OAAwB;QACtI,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,iCAAiC;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEhD,qDAAqD;QACrD,iDAAiD;QACjD,MAAM,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,QAAsB,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,WAAW;YACX,YAAY;YACZ,QAAQ,EAAE,aAAa;YACvB,WAAW;YACX,QAAQ;YACR,OAAO;YACP,KAAK,EAAE,KAAK,CAAC,OAAO;YACpB,SAAS;YACT,SAAS;YACT,SAAS;YACT,OAAO,EAAE,KAAK;YACd,UAAU;SACX,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;IAEO,cAAc,CAAC,IAAoB;QACzC,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,kBAAkB,CAAC,IAAoB;QAC7C,IAAI,aAAa,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/B,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QAClC,CAAC;QACD,IAAI,aAAa,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;QACtC,CAAC;QACD,IAAI,cAAc,IAAI,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAChE,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,eAAe,CAAC,IAAoB;QAC1C,IAAI,aAAa,IAAI,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;QAClC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,oEAAoE;YACpE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;YAC7B,IAAI,WAAW,CAAC,WAAW,CAAC,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3D,OAAO;oBACL,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO;oBACtC,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO;oBAC1C,IAAI,EAAE,aAAa;iBACpB,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF","sourcesContent":["import type { ILogLayer } from 'loglayer';\n\n/**\n * UI Logger: Command-Level Logging for UI Display\n *\n * This module provides a specialized logger for capturing command-level information\n * that can be easily parsed and displayed in a UI. It captures details about\n * commands, data sent, data expected, and data received in a structured format.\n *\n * Purpose:\n * - Captures command-level information for UI display\n * - Provides structured JSON logging for easy parsing\n * - Tracks command execution details including timing\n * - Supports protocol debugging in UI environments\n * - Maintains separation from debug logging\n *\n * Design Rationale:\n * - Single log entry per command provides clean UI display\n * - JSON structure enables easy parsing and filtering\n * - Command-level granularity is appropriate for UI debugging\n * - Structured data supports rich UI representations\n * - Separate from debug logging avoids UI noise\n */\n\ninterface ProtocolContext {\n  variables?: Map<string, unknown>;\n}\n\n/**\n * Generic protocol step interface for UI logging\n */\nexport type UIProtocolStep = Record<string, unknown>;\n\n/**\n * Type guards for protocol step properties\n */\nconst hasDescription = (obj: unknown): obj is { description: string } =>\n  typeof obj === 'object' && obj !== null && 'description' in obj && typeof (obj as Record<string, unknown>).description === 'string';\n\nconst hasReceive = (obj: unknown): obj is { receive: unknown } => typeof obj === 'object' && obj !== null && 'receive' in obj;\n\nconst hasEndChunk = (obj: unknown): obj is { endChunk: { receive: unknown } } =>\n  typeof obj === 'object' &&\n  obj !== null &&\n  'endChunk' in obj &&\n  typeof (obj as Record<string, unknown>).endChunk === 'object' &&\n  (obj as Record<string, unknown>).endChunk !== null &&\n  'receive' in ((obj as Record<string, unknown>).endChunk as Record<string, unknown>);\n\nconst hasStartChunk = (obj: unknown): obj is { startChunk: { receive: unknown } } =>\n  typeof obj === 'object' &&\n  obj !== null &&\n  'startChunk' in obj &&\n  typeof (obj as Record<string, unknown>).startChunk === 'object' &&\n  (obj as Record<string, unknown>).startChunk !== null &&\n  'receive' in ((obj as Record<string, unknown>).startChunk as Record<string, unknown>);\n\n/**\n * UI Logger for capturing command-level information for UI display\n */\nexport class UILogger {\n  private logger: ILogLayer;\n  private commandStartTimes = new Map<string, number>();\n\n  constructor(logger: ILogLayer) {\n    this.logger = logger;\n  }\n\n  // eslint-disable-next-line max-params\n  startCommand(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = Date.now();\n    this.commandStartTimes.set(commandId, startTime);\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    this.logger\n      .withMetadata({\n        commandId,\n        commandType,\n        description,\n        operation,\n        startTime,\n        stepIndex,\n        totalSteps,\n      })\n      .info('Command started');\n  }\n\n  // eslint-disable-next-line max-params\n  logCommandSuccess(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep, context: ProtocolContext): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = this.commandStartTimes.get(commandId) || Date.now();\n    const endTime = Date.now();\n    const duration = endTime - startTime;\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    // Extract sent and received data from context\n    const dataSent = context.variables && context.variables.get('lastSentData');\n    const dataReceived = context.variables && context.variables.get('lastReceivedData');\n    const dataExpected = this.getExpectedData(step);\n\n    // For readSegment, also extract chunk logs if present\n    const dataChunks = commandType === 'readSegment' && context.variables && context.variables.get('lastReadSegmentChunks');\n\n    // Convert dataSent and dataReceived to byte array format if they exist\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataSentArray = dataSent && Array.from(dataSent as Uint8Array);\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataReceivedArray = dataReceived && Array.from(dataReceived as Uint8Array);\n\n    this.logger\n      .withMetadata({\n        commandType,\n        dataChunks,\n        dataExpected,\n        dataReceived: dataReceivedArray,\n        dataSent: dataSentArray,\n        description,\n        duration,\n        endTime,\n        operation,\n        startTime,\n        stepIndex,\n        success: true,\n        totalSteps,\n      })\n      .info('Command completed successfully');\n  }\n\n  // eslint-disable-next-line max-params\n  logCommandFailure(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep, error: Error, context: ProtocolContext): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = this.commandStartTimes.get(commandId) || Date.now();\n    const endTime = Date.now();\n    const duration = endTime - startTime;\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    // Extract sent data from context\n    const dataSent = context.variables && context.variables.get('lastSentData');\n    const dataExpected = this.getExpectedData(step);\n\n    // Convert dataSent to byte array format if it exists\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataSentArray = dataSent && Array.from(dataSent as Uint8Array);\n\n    this.logger\n      .withMetadata({\n        commandType,\n        dataExpected,\n        dataSent: dataSentArray,\n        description,\n        duration,\n        endTime,\n        error: error.message,\n        operation,\n        startTime,\n        stepIndex,\n        success: false,\n        totalSteps,\n      })\n      .info('Command failed');\n  }\n\n  private getCommandType(step: UIProtocolStep): string {\n    if ('sendReceive' in step) {\n      return 'sendReceive';\n    }\n    if ('send' in step) {\n      return 'send';\n    }\n    if ('receive' in step) {\n      return 'receive';\n    }\n    if ('readSegment' in step) {\n      return 'readSegment';\n    }\n    if ('writeSegment' in step) {\n      return 'writeSegment';\n    }\n    if ('setVariable' in step) {\n      return 'setVariable';\n    }\n    return 'unknown';\n  }\n\n  private getStepDescription(step: UIProtocolStep): string {\n    if ('sendReceive' in step && hasDescription(step.sendReceive)) {\n      return step.sendReceive.description;\n    }\n    if ('send' in step && hasDescription(step.send)) {\n      return step.send.description;\n    }\n    if ('receive' in step && hasDescription(step.receive)) {\n      return step.receive.description;\n    }\n    if ('readSegment' in step && hasDescription(step.readSegment)) {\n      return step.readSegment.description;\n    }\n    if ('writeSegment' in step && hasDescription(step.writeSegment)) {\n      return step.writeSegment.description;\n    }\n    return 'No description';\n  }\n\n  private getExpectedData(step: UIProtocolStep): unknown {\n    if ('sendReceive' in step && hasReceive(step.sendReceive)) {\n      return step.sendReceive.receive;\n    }\n    if ('receive' in step) {\n      return step.receive;\n    }\n    if ('readSegment' in step) {\n      // For readSegment, return both start and end chunk receive patterns\n      const { readSegment } = step;\n      if (hasEndChunk(readSegment) && hasStartChunk(readSegment)) {\n        return {\n          endChunk: readSegment.endChunk.receive,\n          startChunk: readSegment.startChunk.receive,\n          type: 'readSegment',\n        };\n      }\n    }\n    return {};\n  }\n}\n"]}
+{"version":3,"file":"ui-logger.js","sourceRoot":"","sources":["../../src/utils/ui-logger.ts"],"names":[],"mappings":"AAmBA,MAAM,cAAc,GAAG,CAAC,GAAY,EAAkC,EAAE,CACtE,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,aAAa,IAAI,GAAG,IAAI,OAAQ,GAA+B,CAAC,WAAW,KAAK,QAAQ,CAAC;AAEtI;;GAEG;AACH,MAAM,OAAO,QAAQ;IACX,MAAM,CAAY;IAClB,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEtD,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,sCAAsC;IACtC,YAAY,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB;QACzF,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAEjD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,SAAS;YACT,WAAW;YACX,WAAW;YACX,SAAS;YACT,SAAS;YACT,SAAS;YACT,UAAU;SACX,CAAC;aACD,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,sCAAsC;IACtC,iBAAiB,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB,EAAE,OAAwB;QACxH,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACpF,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,WAAW,KAAK,MAAM,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAEjH,iDAAiD;QACjD,MAAM,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,QAAsB,CAAC,CAAC;QACrE,iDAAiD;QACjD,MAAM,iBAAiB,GAAG,YAAY,IAAI,KAAK,CAAC,IAAI,CAAC,YAA0B,CAAC,CAAC;QAEjF,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,WAAW;YACX,UAAU;YACV,YAAY;YACZ,YAAY,EAAE,iBAAiB;YAC/B,QAAQ,EAAE,aAAa;YACvB,WAAW;YACX,QAAQ;YACR,OAAO;YACP,SAAS;YACT,SAAS;YACT,SAAS;YACT,OAAO,EAAE,IAAI;YACb,UAAU;SACX,CAAC;aACD,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAC5C,CAAC;IAED,sCAAsC;IACtC,iBAAiB,CAAC,SAAiB,EAAE,UAAkB,EAAE,SAAiB,EAAE,IAAoB,EAAE,KAAY,EAAE,OAAwB;QACtI,MAAM,SAAS,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEhD,iDAAiD;QACjD,MAAM,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,QAAsB,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM;aACR,YAAY,CAAC;YACZ,WAAW;YACX,YAAY;YACZ,QAAQ,EAAE,aAAa;YACvB,WAAW;YACX,QAAQ;YACR,OAAO;YACP,KAAK,EAAE,KAAK,CAAC,OAAO;YACpB,SAAS;YACT,SAAS;YACT,SAAS;YACT,OAAO,EAAE,KAAK;YACd,UAAU;SACX,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5B,CAAC;IAEO,cAAc,CAAC,IAAoB;QACzC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,IAAI,MAAM,IAAI,IAAI,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACvC,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,kBAAkB,CAAC,IAAoB;QAC7C,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,eAAe,CAAC,IAAoB;QAC1C,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACnG,MAAM,IAAI,GAAG,IAAI,CAAC,IAAuD,CAAC;YAC1E,OAAO;gBACL,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,MAAM;aACtB,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACvG,OAAQ,IAAI,CAAC,KAA6B,CAAC,MAAM,CAAC;QACpD,CAAC;QACD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF","sourcesContent":["import type { ILogLayer } from 'loglayer';\n\n/**\n * UI Logger: Command-Level Logging for UI Display\n *\n * This module provides a specialized logger for capturing command-level information\n * that can be easily parsed and displayed in a UI. It captures details about\n * commands, data sent, data expected, and data received in a structured format.\n */\n\ninterface ProtocolContext {\n  variables?: Map<string, unknown>;\n}\n\n/**\n * Generic protocol step interface for UI logging\n */\nexport type UIProtocolStep = Record<string, unknown>;\n\nconst hasDescription = (obj: unknown): obj is { description: string } =>\n  typeof obj === 'object' && obj !== null && 'description' in obj && typeof (obj as Record<string, unknown>).description === 'string';\n\n/**\n * UI Logger for capturing command-level information for UI display\n */\nexport class UILogger {\n  private logger: ILogLayer;\n  private commandStartTimes = new Map<string, number>();\n\n  constructor(logger: ILogLayer) {\n    this.logger = logger;\n  }\n\n  // eslint-disable-next-line max-params\n  startCommand(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = Date.now();\n    this.commandStartTimes.set(commandId, startTime);\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    this.logger\n      .withMetadata({\n        commandId,\n        commandType,\n        description,\n        operation,\n        startTime,\n        stepIndex,\n        totalSteps,\n      })\n      .info('Command started');\n  }\n\n  // eslint-disable-next-line max-params\n  logCommandSuccess(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep, context: ProtocolContext): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = this.commandStartTimes.get(commandId) || Date.now();\n    const endTime = Date.now();\n    const duration = endTime - startTime;\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    const dataSent = context.variables && context.variables.get('lastSentData');\n    const dataReceived = context.variables && context.variables.get('lastReceivedData');\n    const dataExpected = this.getExpectedData(step);\n    const dataChunks = commandType === 'read' && context.variables && context.variables.get('lastReadSegmentChunks');\n\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataSentArray = dataSent && Array.from(dataSent as Uint8Array);\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataReceivedArray = dataReceived && Array.from(dataReceived as Uint8Array);\n\n    this.logger\n      .withMetadata({\n        commandType,\n        dataChunks,\n        dataExpected,\n        dataReceived: dataReceivedArray,\n        dataSent: dataSentArray,\n        description,\n        duration,\n        endTime,\n        operation,\n        startTime,\n        stepIndex,\n        success: true,\n        totalSteps,\n      })\n      .info('Command completed successfully');\n  }\n\n  // eslint-disable-next-line max-params\n  logCommandFailure(stepIndex: number, totalSteps: number, operation: string, step: UIProtocolStep, error: Error, context: ProtocolContext): void {\n    const commandId = `${operation}-${stepIndex}`;\n    const startTime = this.commandStartTimes.get(commandId) || Date.now();\n    const endTime = Date.now();\n    const duration = endTime - startTime;\n\n    const commandType = this.getCommandType(step);\n    const description = this.getStepDescription(step);\n\n    const dataSent = context.variables && context.variables.get('lastSentData');\n    const dataExpected = this.getExpectedData(step);\n\n    // eslint-disable-next-line unicorn/prefer-spread\n    const dataSentArray = dataSent && Array.from(dataSent as Uint8Array);\n\n    this.logger\n      .withMetadata({\n        commandType,\n        dataExpected,\n        dataSent: dataSentArray,\n        description,\n        duration,\n        endTime,\n        error: error.message,\n        operation,\n        startTime,\n        stepIndex,\n        success: false,\n        totalSteps,\n      })\n      .info('Command failed');\n  }\n\n  private getCommandType(step: UIProtocolStep): string {\n    if ('read' in step) {\n      return 'read';\n    }\n    if ('write' in step) {\n      return 'write';\n    }\n    if ('send' in step || 'expect' in step) {\n      return 'exchange';\n    }\n    return 'unknown';\n  }\n\n  private getStepDescription(step: UIProtocolStep): string {\n    if (hasDescription(step)) {\n      return step.description;\n    }\n    return 'No description';\n  }\n\n  private getExpectedData(step: UIProtocolStep): unknown {\n    if ('read' in step && typeof step.read === 'object' && step.read !== null && 'expect' in step.read) {\n      const read = step.read as { expect: unknown; ack?: { expect?: unknown } };\n      return {\n        expect: read.expect,\n        ack: read.ack?.expect,\n      };\n    }\n    if ('write' in step && typeof step.write === 'object' && step.write !== null && 'expect' in step.write) {\n      return (step.write as { expect: unknown }).expect;\n    }\n    if ('expect' in step) {\n      return step.expect;\n    }\n    return {};\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-utils",
-  "version": "3.2.5",
+  "version": "4.0.0",
   "author": "Bryan Hunt",
   "license": "MIT",
   "readme": "README.md",
@@ -28,11 +28,11 @@
     "prepare": "husky"
   },
   "dependencies": {
-    "@springfield/ham-radio-api": "^16.3.4",
-    "ajv": "^8.17.1",
+    "@springfield/ham-radio-api": "^17.0.0",
+    "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1",
     "fishery": "^2.4.0",
-    "loglayer": "^8.5.0",
+    "loglayer": "^9.4.0",
     "sprintf-js": "^1.1.3"
   },
   "devDependencies": {
@@ -40,12 +40,12 @@
     "@commitlint/config-conventional": "21.2.2",
     "@semantic-release/changelog": "7.0.0",
     "@semantic-release/git": "11.0.1",
-    "@semantic-release/github": "12.0.2",
+    "@semantic-release/github": "12.0.9",
     "@semantic-release/npm": "13.1.5",
     "@types/chai": "5.2.3",
-    "@types/node": "24.13.3",
+    "@types/node": "26.2.0",
     "@types/sprintf-js": "1.1.4",
-    "chai": "6.2.1",
+    "chai": "6.2.2",
     "husky": "9.1.7",
     "oxfmt": "^0.64.0",
     "oxlint": "1.79.0",

package/src/schemas/radio-protocol-schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Radio Protocol DSL Schema",
-  "description": "Schema for defining radio communication protocols in a declarative JSON format",
+  "description": "Schema for defining radio communication protocols as send/expect exchanges",
   "type": "object",
   "required": [
     "id",
@@ -169,7 +169,7 @@
               },
               "endAddress": {
                 "type": "integer",
-                "description": "Ending address (inclusive) of the memory segment",
+                "description": "Inclusive ending address of the memory segment",
                 "minimum": 0
               }
             }
@@ -194,358 +194,192 @@
   },
   "definitions": {
     "protocolStep": {
-      "type": "object",
-      "description": "A single protocol step",
+      "description": "A single protocol step: an exchange, a chunked read, or a chunked write",
       "oneOf": [
         {
-          "type": "object",
-          "required": [
-            "sendReceive"
-          ],
-          "properties": {
-            "sendReceive": {
-              "$ref": "#/definitions/sendReceiveStep"
-            }
-          }
+          "$ref": "#/definitions/readStep"
         },
         {
-          "type": "object",
-          "required": [
-            "send"
-          ],
-          "properties": {
-            "send": {
-              "$ref": "#/definitions/sendStep"
-            }
-          }
+          "$ref": "#/definitions/writeStep"
         },
         {
-          "type": "object",
-          "required": [
-            "receive"
-          ],
-          "properties": {
-            "receive": {
-              "$ref": "#/definitions/receiveStep"
-            }
-          }
+          "$ref": "#/definitions/exchangeStep"
+        }
+      ]
+    },
+    "byteToken": {
+      "description": "A send/expect token: a byte, hex string (0x50), ASCII opcode (S), or placeholder ($address)",
+      "oneOf": [
+        {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 255
         },
         {
-          "type": "object",
-          "required": [
-            "readSegment"
-          ],
-          "properties": {
-            "readSegment": {
-              "$ref": "#/definitions/readSegmentStep"
-            }
-          }
+          "type": "string",
+          "minLength": 1
+        }
+      ]
+    },
+    "sendData": {
+      "type": "array",
+      "description": "Bytes and placeholders to send",
+      "items": {
+        "$ref": "#/definitions/byteToken"
+      }
+    },
+    "expect": {
+      "description": "Expected serial reply: exact byte(s), opaque length, or a framed pattern",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/byteToken"
         },
         {
-          "type": "object",
-          "required": [
-            "writeSegment"
-          ],
-          "properties": {
-            "writeSegment": {
-              "$ref": "#/definitions/writeSegmentStep"
-            }
-          }
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/byteToken"
+          },
+          "minItems": 1
         },
         {
           "type": "object",
           "required": [
-            "setVariable"
+            "bytes"
           ],
+          "additionalProperties": false,
           "properties": {
-            "setVariable": {
-              "$ref": "#/definitions/setVariableStep"
+            "bytes": {
+              "type": "integer",
+              "description": "Accept any content of this many bytes",
+              "minimum": 1
             }
           }
         }
       ]
     },
-    "sendReceiveStep": {
+    "exchangeStep": {
       "type": "object",
-      "description": "Send data and receive response",
-      "required": [
-        "send",
-        "receive"
+      "description": "Send bytes and/or wait for a reply",
+      "anyOf": [
+        {
+          "required": [
+            "send"
+          ]
+        },
+        {
+          "required": [
+            "expect"
+          ]
+        }
       ],
+      "additionalProperties": false,
       "properties": {
+        "description": {
+          "type": "string",
+          "description": "Human-readable description of the step"
+        },
         "send": {
           "$ref": "#/definitions/sendData"
         },
-        "receive": {
-          "$ref": "#/definitions/receiveConfig"
+        "expect": {
+          "$ref": "#/definitions/expect"
         },
         "timeout": {
           "type": "integer",
           "description": "Timeout in milliseconds",
           "minimum": 1,
           "default": 5000
-        },
-        "description": {
-          "type": "string",
-          "description": "Human-readable description of the step"
         }
       }
     },
-    "sendStep": {
+    "readStep": {
       "type": "object",
-      "description": "Send data only",
+      "description": "Chunked memory read",
       "required": [
-        "data"
+        "read"
       ],
+      "additionalProperties": false,
       "properties": {
-        "data": {
-          "$ref": "#/definitions/sendData"
-        },
         "description": {
           "type": "string",
           "description": "Human-readable description of the step"
-        }
-      }
-    },
-    "receiveStep": {
-      "type": "object",
-      "description": "Receive data only",
-      "required": [
-        "type",
-        "length"
-      ],
-      "properties": {
-        "type": {
-          "type": "string",
-          "enum": [
-            "exact",
-            "variable",
-            "pattern",
-            "any"
-          ],
-          "description": "Type of receive operation"
-        },
-        "value": {
-          "type": "integer",
-          "description": "Expected value for exact match",
-          "minimum": 0,
-          "maximum": 255
-        },
-        "length": {
-          "type": "integer",
-          "description": "Expected length in bytes",
-          "minimum": 1
         },
-        "pattern": {
-          "type": "array",
-          "description": "Pattern for structured responses",
-          "items": {
-            "oneOf": [
-              {
-                "type": "string",
-                "description": "Literal value (1 byte)"
-              },
-              {
-                "type": "number",
-                "description": "Literal value (1 byte)"
+        "read": {
+          "type": "object",
+          "required": [
+            "segments",
+            "send",
+            "expect"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "segments": {
+              "type": "array",
+              "description": "Memory segment names to read",
+              "items": {
+                "type": "string"
               },
-              {
-                "type": "object",
-                "required": [
-                  "field",
-                  "size"
-                ],
-                "properties": {
-                  "field": {
-                    "type": "string",
-                    "description": "Field name for extracted data"
-                  },
-                  "size": {
-                    "type": "integer",
-                    "description": "Size in bytes (0 for variable length)",
-                    "minimum": 0
-                  }
-                }
-              }
-            ]
-          }
-        },
-        "description": {
-          "type": "string",
-          "description": "Human-readable description of the step"
-        }
-      }
-    },
-    "readSegmentStep": {
-      "type": "object",
-      "description": "Read memory segments",
-      "required": [
-        "segments",
-        "startChunk",
-        "endChunk"
-      ],
-      "properties": {
-        "segments": {
-          "type": "array",
-          "description": "List of segment names to read",
-          "items": {
-            "type": "string"
+              "minItems": 1
+            },
+            "send": {
+              "$ref": "#/definitions/sendData"
+            },
+            "expect": {
+              "$ref": "#/definitions/expect"
+            },
+            "ack": {
+              "$ref": "#/definitions/exchangeStep",
+              "description": "Optional exchange after each chunk"
+            },
+            "timeout": {
+              "type": "integer",
+              "description": "Timeout in milliseconds for each chunk exchange",
+              "minimum": 1
+            }
           }
-        },
-        "startChunk": {
-          "$ref": "#/definitions/sendReceiveStep",
-          "description": "Protocol for starting a chunk read"
-        },
-        "endChunk": {
-          "$ref": "#/definitions/sendReceiveStep",
-          "description": "Protocol for ending a chunk read"
-        },
-        "description": {
-          "type": "string",
-          "description": "Human-readable description of the step"
         }
       }
     },
-    "writeSegmentStep": {
+    "writeStep": {
       "type": "object",
-      "description": "Write memory segments",
+      "description": "Chunked memory write",
       "required": [
-        "segments",
-        "send",
-        "data",
-        "receive"
+        "write"
       ],
+      "additionalProperties": false,
       "properties": {
-        "segments": {
-          "type": "array",
-          "description": "List of segment names to write",
-          "items": {
-            "type": "string"
-          }
-        },
-        "send": {
-          "$ref": "#/definitions/sendData",
-          "description": "Data to send for write command"
-        },
-        "data": {
-          "type": "string",
-          "description": "Expression for segment data to write"
-        },
-        "receive": {
-          "$ref": "#/definitions/receiveConfig",
-          "description": "Expected response for write command"
-        },
         "description": {
           "type": "string",
           "description": "Human-readable description of the step"
-        }
-      }
-    },
-    "setVariableStep": {
-      "type": "object",
-      "description": "Set a variable value",
-      "required": [
-        "name",
-        "value"
-      ],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Variable name"
         },
-        "value": {
-          "oneOf": [
-            {
-              "type": "string",
-              "description": "Expression or literal value"
-            },
-            {
-              "type": "number",
-              "description": "Numeric value"
-            }
-          ],
-          "description": "Value to assign to the variable"
-        }
-      }
-    },
-    "sendData": {
-      "type": "array",
-      "description": "Array of data to send",
-      "items": {
-        "oneOf": [
-          {
-            "type": "string",
-            "description": "String literal or expression"
-          },
-          {
-            "type": "number",
-            "description": "Numeric literal or expression",
-            "minimum": 0,
-            "maximum": 255
-          }
-        ]
-      }
-    },
-    "receiveConfig": {
-      "type": "object",
-      "description": "Configuration for receiving data",
-      "required": [
-        "type"
-      ],
-      "properties": {
-        "type": {
-          "type": "string",
-          "enum": [
-            "exact",
-            "variable",
-            "pattern",
-            "any"
+        "write": {
+          "type": "object",
+          "required": [
+            "segments",
+            "send",
+            "expect"
           ],
-          "description": "Type of receive operation"
-        },
-        "value": {
-          "type": "integer",
-          "description": "Expected value for exact match",
-          "minimum": 0,
-          "maximum": 255
-        },
-        "length": {
-          "type": "integer",
-          "description": "Expected length in bytes",
-          "minimum": 1
-        },
-        "pattern": {
-          "type": "array",
-          "description": "Pattern for structured responses",
-          "items": {
-            "oneOf": [
-              {
-                "type": "string",
-                "description": "Literal value (1 byte)"
-              },
-              {
-                "type": "number",
-                "description": "Literal value (1 byte)"
+          "additionalProperties": false,
+          "properties": {
+            "segments": {
+              "type": "array",
+              "description": "Memory segment names to write",
+              "items": {
+                "type": "string"
               },
-              {
-                "type": "object",
-                "required": [
-                  "field",
-                  "size"
-                ],
-                "properties": {
-                  "field": {
-                    "type": "string",
-                    "description": "Field name for extracted data"
-                  },
-                  "size": {
-                    "type": "integer",
-                    "description": "Size in bytes (0 for variable length)",
-                    "minimum": 0
-                  }
-                }
-              }
-            ]
+              "minItems": 1
+            },
+            "send": {
+              "$ref": "#/definitions/sendData"
+            },
+            "expect": {
+              "$ref": "#/definitions/expect"
+            },
+            "timeout": {
+              "type": "integer",
+              "description": "Timeout in milliseconds for each chunk exchange",
+              "minimum": 1
+            }
           }
         }
       }