refactor!: ESM support and use of built-in dependencies

Release-As: 2.0.0

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Corneliu Duplachi
+Copyright (c) Corneliu Duplachi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -4,15 +4,16 @@
     "./packages/*"
   ],
   "scripts": {
-    "build": "npm run build -ws"
+    "build": "npm run build -ws",
+    "test": "npm run test -ws --if-present"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.2",
     "@tsconfig/strictest": "^2.0.2",
-    "@types/node": "^20.9.1",
-    "@types/sinon": "^17.0.1",
+    "@types/node": "^20.10.2",
+    "@types/sinon": "^17.0.2",
     "sinon": "^17.0.1",
-    "tsx": "^4.1.3",
-    "typescript": "^5.2.2"
+    "tsx": "^4.6.2",
+    "typescript": "^5.3.2"
   }
 }

packages/debug-server/README.md

@@ -23,7 +23,7 @@ const plugins = await getPlugins(ctx);
 console.log(plugins);
 
 // raw
-const rawResult = await ctx.execute('plugins', []);
+const rawResult = await ctx.execute('plugins');
 console.log(rawResult);
 ```
 

packages/debug-server/src/DebugServerError.ts

@@ -1,13 +1,11 @@
 export class DebugServerError extends Error {
-  public readonly cmd: string;
-  public readonly args: string[];
+  public readonly command: string;
   public readonly output: string;
 
-  constructor(options: { cmd: string; args: string[]; output: string }) {
-    super(`Command "${options.cmd}" failed: ${options.output}`);
+  constructor(options: { command: string; output: string }) {
+    super(`Command "${options.command}" failed with output: ${options.output}`);
     this.name = 'DebugServerError';
-    this.cmd = options.cmd;
-    this.args = options.args || [];
+    this.command = options.command;
     this.output = options.output;
   }
 }

packages/debug-server/src/DebugServerExecutor.ts

@@ -1,16 +1,14 @@
-import { createConnection } from 'node:net';
-import type { Executor } from './Executor.js';
-
-type DebugServerExecutorOptions = {
-  signal?: AbortSignal;
-};
+import { connect } from 'node:net';
+import { Readable } from 'node:stream';
+import type { DebugServerExecutorOptions } from './DebugServerExecutorOptions.ts';
+import type { Executor } from './Executor.ts';
 
 export class DebugServerExecutor
   implements Executor<DebugServerExecutorOptions>
 {
   #hostname: string;
   #port: number;
-  #signal?: AbortSignal | undefined;
+  #signal?: AbortSignal;
 
   constructor(options: {
     hostname: string;
@@ -19,12 +17,11 @@ export class DebugServerExecutor
   }) {
     this.#hostname = options.hostname;
     this.#port = options.port;
-    this.#signal = options.signal;
+    this.#signal = options.signal!;
   }
 
   async execute(
     command: string,
-    args: string[],
     config?: DebugServerExecutorOptions
   ): Promise<string> {
     const signal =
@@ -33,35 +30,17 @@ export class DebugServerExecutor
           AbortSignal.any([this.#signal, config.signal])
         : this.#signal || config?.signal;
 
-    return new Promise((resolve, reject) => {
-      const cmd = `${command} ${args.join(' ')}`.replace(/\s/g, ' ').trimEnd();
-
-      const client = createConnection(
-        { host: this.#hostname, port: this.#port, signal },
-        () => {
-          client.write(`${cmd}\nq\n`);
-        }
-      );
-
-      let chunks: Buffer[] = [];
-
-      client.on('data', (chunk) => {
-        chunks.push(chunk);
-      });
-
-      client.on('end', () => {
-        const response = Buffer.concat(chunks)
-          .toString()
-          .replace(/\r\n?/g, '\n');
+    const socket = connect(
+      { host: this.#hostname, port: this.#port, signal },
+      () => {
+        socket.write(`${command}\nq\n`);
+      }
+    );
 
-        const start = response.indexOf('\n>') + 2;
-        const end = response.lastIndexOf('\n>');
-        resolve(response.slice(start, end).trim());
-      });
+    const result = await new Response(Readable.toWeb(socket)).text();
 
-      client.on('error', (error) => {
-        reject(error);
-      });
-    });
+    return result
+      .slice(result.indexOf('\n>') + 2, result.lastIndexOf('\n>'))
+      .trim();
   }
 }

packages/debug-server/src/DebugServerExecutorOptions.ts

@@ -0,0 +1,3 @@
+export interface DebugServerExecutorOptions {
+  signal?: AbortSignal;
+}

packages/debug-server/src/Executor.ts

@@ -1,3 +1,3 @@
-export interface Executor<Config> {
-  execute(command: string, args: string[], config?: Config): Promise<string>;
+export interface Executor<Config = {}> {
+  execute(command: string, config?: Config): Promise<string>;
 }

packages/debug-server/src/commands/clearLaunchCaches.ts

@@ -1,14 +1,15 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /Done/;
 
 /**
  * Clear all caches that can affect channel launch time.
  */
-export async function clearLaunchCaches<Context extends Executor<{}>>(
+export async function clearLaunchCaches<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<void> {
-  await execute(ctx, 'clear_launch_caches', [], [pattern], config);
+  await execute(ctx, 'clear_launch_caches', [pattern], config);
 }

packages/debug-server/src/commands/clearSceneGraphPerformanceMetrics.ts

@@ -1,13 +1,14 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /^\s*$/;
 
 /**
  * Clear SceneGraph node operation performance metrics.
  */
 export async function clearSceneGraphPerformanceMetrics<
-  Context extends Executor<{}>
+  Context extends Executor
 >(ctx: Context, config?: Config<Context>): Promise<void> {
-  await execute(ctx, 'sgperf', ['clear'], [pattern], config);
+  await execute(ctx, 'sgperf clear', [pattern], config);
 }

packages/debug-server/src/commands/createDeveloperKey.ts

@@ -1,5 +1,6 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 import type { DeveloperKey } from '../types/DeveloperKey.ts';
 
 const idPattern = /DevID: (.*)/;
@@ -8,14 +9,13 @@ const passwordPattern = /Password: (.*)/;
 /**
  * Generate a new developer key.
  */
-export async function createDeveloperKey<Context extends Executor<{}>>(
+export async function createDeveloperKey<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<DeveloperKey> {
   const result = await execute(
     ctx,
     'genkey',
-    [],
     [idPattern, passwordPattern],
     config
   );

packages/debug-server/src/commands/disableRendezvousLogging.ts

@@ -1,14 +1,15 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /rendezvous logging is off/;
 
 /**
  * Disable rendezvous logging.
  */
-export async function disableRendezvousLogging<Context extends Executor<{}>>(
+export async function disableRendezvousLogging<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<void> {
-  await execute(ctx, 'logrendezvous', ['off'], [pattern], config);
+  await execute(ctx, 'logrendezvous off', [pattern], config);
 }

packages/debug-server/src/commands/enableRendezvousLogging.ts

@@ -1,14 +1,15 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /rendezvous logging is on/;
 
 /**
  * Enable rendezvous logging.
  */
-export async function enableRendezvousLogging<Context extends Executor<{}>>(
+export async function enableRendezvousLogging<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<void> {
-  await execute(ctx, 'logrendezvous', ['on'], [pattern], config);
+  await execute(ctx, 'logrendezvous on', [pattern], config);
 }

packages/debug-server/src/commands/getChannelPerformanceStats.ts

@@ -1,6 +1,7 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
-import type { ChannelStats } from '../types/ChannelStats.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
+import type { ChannelStats } from '../types/ChannelStats.ts';
 
 const pattern =
   /mem=(?<mem>\d+)KiB{anon=(?<anon>\d+),file=(?<file>\d+),shared=(?<shared>\d+),swap=(?<swap>\d+)},%cpu=(?<cpu>\d+){user=(?<user>\d+),sys=(?<sys>\d+)}/;
@@ -10,11 +11,11 @@ const pattern =
  *
  * The channel manifest must include the **run_as_process=1** attribute to use this command.
  */
-export async function getChannelPerformanceStats<Context extends Executor<{}>>(
+export async function getChannelPerformanceStats<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<ChannelStats> {
-  const [[result]] = await execute(ctx, 'chanperf', [], [pattern], config);
+  const [[result]] = await execute(ctx, 'chanperf', [pattern], config);
 
   return {
     cpu: {

packages/debug-server/src/commands/getDeveloperKey.ts

@@ -1,15 +1,16 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /Dev ID: (.+)/;
 
 /**
  * Returns current developer key.
  */
-export async function getDeveloperKey<Context extends Executor<{}>>(
+export async function getDeveloperKey<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<string> {
-  const [[result]] = await execute(ctx, 'showkey', [], [pattern], config);
+  const [[result]] = await execute(ctx, 'showkey', [pattern], config);
   return result[1];
 }

packages/debug-server/src/commands/getLoadedTextures.ts

@@ -1,13 +1,14 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 import type { LoadedTextures } from '../types/LoadedTextures.ts';
 
 const pattern = /\* .+ Textures +\*/;
 
 /**
  * Returns loaded textures.
  */
-export async function getLoadedTextures<Context extends Executor<{}>>(
+export async function getLoadedTextures<Context extends Executor>(
   ctx: Context,
   payload?: {
     /**
@@ -17,11 +18,9 @@ export async function getLoadedTextures<Context extends Executor<{}>>(
   },
   config?: Config<Context>
 ): Promise<LoadedTextures> {
-  const args = payload?.overlay ? [payload.overlay] : [];
   const [[match]] = await execute(
     ctx,
-    'loaded_textures',
-    args,
+    `loaded_textures${payload?.overlay ? ' ' + payload.overlay : ''}`,
     [pattern],
     config
   );

packages/debug-server/src/commands/getMaxWarningCount.ts

@@ -1,20 +1,20 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 
 const pattern = /brightscript warning limit: (\d+)/;
 
 /**
  * Returns the maximum number of BrightScript warnings that can be displayed
  * in the BrightScript console (port 8085).
  */
-export async function getMaxWarningCount<Context extends Executor<{}>>(
+export async function getMaxWarningCount<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<number> {
   const [[result]] = await execute(
     ctx,
     'brightscript_warnings',
-    [],
     [pattern],
     config
   );

packages/debug-server/src/commands/getMemoryStats.ts

@@ -1,5 +1,6 @@
-import type { Executor } from '../Executor.js';
-import { execute, type Config } from '../internal/execute.js';
+import type { Executor } from '../Executor.ts';
+import { execute } from '../internal/execute.js';
+import type { Config } from '../internal/types.d.ts';
 import type { MemoryStats } from '../types/MemoryStats.ts';
 
 const memoryPattern =
@@ -9,14 +10,13 @@ const swapPattern = /Swap:\s*(?<total>\d+)\s*(?<used>\d+)\s*(?<free>\d+)/;
 /**
  * Returns memory stats.
  */
-export async function getMemoryStats<Context extends Executor<{}>>(
+export async function getMemoryStats<Context extends Executor>(
   ctx: Context,
   config?: Config<Context>
 ): Promise<MemoryStats> {
   const [[memory], [swap]] = await execute(
     ctx,
     'free',
-    [],
     [memoryPattern, swapPattern],
     config
   );