@bun-native/protocol 0.33.0 → 0.33.1

package/src/processes.ts

@@ -1,6 +1,6 @@
 import { ProtocolError } from './framing.ts'
 import { parseChunk, parseFilePath, parseRootId, parseRootPath } from './files.ts'
-import { id, integer, keys, object } from './values.ts'
+import { fields, id, integer, keys, object } from './values.ts'
 
 export const MAX_PROCESS_EXECUTABLES = 8
 export const MAX_PROCESSES = 8
@@ -48,9 +48,11 @@ const LIMIT_BOUNDS = {
   open_files: [MIN_PROCESS_OPEN_FILES, MAX_PROCESS_OPEN_FILES],
 } as const
 
-export function parseProcessLimits(value: unknown): ProcessLimits {
+const PROCESS_LIMITS_KEYS = fields(...LIMIT_NAMES)
+
+function parseProcessLimits(value: unknown): ProcessLimits {
   const data = object(value)
-  keys(data, [...LIMIT_NAMES])
+  keys(data, PROCESS_LIMITS_KEYS)
   const limits: ProcessLimits = {}
   for (const name of LIMIT_NAMES)
     if (name in data) {
@@ -103,9 +105,11 @@ export type ProcessSignal = (typeof PROCESS_SIGNALS)[number]
 export type ProcessStream = 'stdout' | 'stderr' | 'terminal'
 export type ProcessExit = { code: number } | { signal: number }
 
+const EXECUTABLE_KEYS = fields('id', 'executable', 'limits')
+
 function executable(value: unknown): ProcessExecutable {
   const data = object(value)
-  keys(data, ['id', 'executable', 'limits'])
+  keys(data, EXECUTABLE_KEYS)
   const path = parseRootPath(data['executable'])
   // `/` and `X:\` are the only normalized paths ending in a separator.
   if (path.endsWith('/') || path.endsWith('\\'))
@@ -169,9 +173,11 @@ function plain(value: unknown, limit: number, field: string): string {
   return value
 }
 
+const TERMINAL_SIZE_KEYS = fields('columns', 'rows')
+
 export function parseTerminalSize(value: unknown): TerminalSize {
   const data = object(value)
-  keys(data, ['columns', 'rows'])
+  keys(data, TERMINAL_SIZE_KEYS)
   return {
     columns: integer(data['columns'], 'terminal columns', 1, MAX_TERMINAL_DIMENSION),
     rows: integer(data['rows'], 'terminal rows', 1, MAX_TERMINAL_DIMENSION),
@@ -186,9 +192,12 @@ function parseEnvName(value: string): string {
   return value
 }
 
+const PROCESS_LAUNCH_KEYS = fields('executable', 'args', 'env', 'cwd', 'terminal')
+const PROCESS_CWD_KEYS = fields('grant_id', 'path')
+
 export function parseProcessLaunch(value: unknown): ProcessLaunch {
   const data = object(value)
-  keys(data, ['executable', 'args', 'env', 'cwd', 'terminal'])
+  keys(data, PROCESS_LAUNCH_KEYS)
   const args = data['args']
   if (!Array.isArray(args) || args.length > MAX_PROCESS_ARGS)
     throw new ProtocolError('Process arguments must be an array of at most ' + MAX_PROCESS_ARGS)
@@ -216,7 +225,7 @@ export function parseProcessLaunch(value: unknown): ProcessLaunch {
   }
   if ('cwd' in data) {
     const cwd = object(data['cwd'])
-    keys(cwd, ['grant_id', 'path'])
+    keys(cwd, PROCESS_CWD_KEYS)
     launch.cwd = { grant_id: id(cwd['grant_id']), path: parseFilePath(cwd['path']) }
   }
   if ('terminal' in data) launch.terminal = parseTerminalSize(data['terminal'])
@@ -241,9 +250,11 @@ export function parseProcessOutput(value: unknown): string {
   return data
 }
 
+const PROCESS_EXIT_KEYS = fields('code', 'signal')
+
 export function parseProcessExit(value: unknown): ProcessExit {
   const data = object(value)
-  keys(data, ['code', 'signal'])
+  keys(data, PROCESS_EXIT_KEYS)
   if ('code' in data && !('signal' in data))
     return { code: integer(data['code'], 'exit code', 0, 255) }
   if ('signal' in data && !('code' in data))

package/src/services.ts

@@ -1,5 +1,5 @@
 import { ProtocolError } from './framing.ts'
-import { keys, number, object, string } from './values.ts'
+import { fields, keys, number, object, string } from './values.ts'
 import { parseFilesystemRoots, type FilesystemRoot } from './files.ts'
 import { parseProcessExecutables, type ProcessExecutable } from './processes.ts'
 
@@ -53,9 +53,11 @@ export interface ShortcutModifiers {
   platform: boolean
 }
 
+const SHORTCUT_MODIFIERS_KEYS = fields('control', 'alt', 'shift', 'platform')
+
 export function parseShortcutModifiers(value: unknown): ShortcutModifiers {
   const data = object(value)
-  keys(data, ['control', 'alt', 'shift', 'platform'])
+  keys(data, SHORTCUT_MODIFIERS_KEYS)
   const flag = (key: keyof ShortcutModifiers) => {
     if (typeof data[key] !== 'boolean')
       throw new ProtocolError('Global shortcut modifiers must state each modifier explicitly')
@@ -103,13 +105,16 @@ export function parseNotificationDismissal(value: unknown): NotificationDismissa
 
 export type ClipboardText = { kind: 'empty' } | { kind: 'text'; text: string }
 
+const CLIPBOARD_TEXT_EMPTY_KEYS = fields('kind')
+const CLIPBOARD_TEXT_READ_KEYS = fields('kind', 'text')
+
 export function parseClipboardText(value: unknown): ClipboardText {
   const data = object(value)
   if (data['kind'] === 'empty') {
-    keys(data, ['kind'])
+    keys(data, CLIPBOARD_TEXT_EMPTY_KEYS)
     return { kind: 'empty' }
   }
-  keys(data, ['kind', 'text'])
+  keys(data, CLIPBOARD_TEXT_READ_KEYS)
   if (data['kind'] !== 'text') throw new ProtocolError('Unknown clipboard text result')
   return { kind: 'text', text: string(data['text'], 'clipboard text', MAX_CLIPBOARD_BYTES) }
 }
@@ -132,9 +137,11 @@ export interface DisplaySnapshot {
 
 const DISPLAY_UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
 
+const DISPLAY_BOUNDS_KEYS = fields('x', 'y', 'width', 'height')
+
 function displayBounds(value: unknown, name: string): DisplayBounds {
   const bounds = object(value)
-  keys(bounds, ['x', 'y', 'width', 'height'])
+  keys(bounds, DISPLAY_BOUNDS_KEYS)
   return {
     x: number(bounds['x'], name + ' x', -1_048_576, 1_048_576),
     y: number(bounds['y'], name + ' y', -1_048_576, 1_048_576),
@@ -143,21 +150,23 @@ function displayBounds(value: unknown, name: string): DisplayBounds {
   }
 }
 
+const SERVICE_POLICY_KEYS = fields(
+  'window_display',
+  'clipboard_read',
+  'clipboard_write',
+  'global_shortcuts',
+  'notifications',
+  'drag_drop',
+  'filesystem_roots',
+  'processes',
+  'file_dialogs',
+  'app_menu',
+  'task_dialogs'
+)
+
 export function parseServicePolicy(value: unknown): ServicePolicy {
   const data = object(value)
-  keys(data, [
-    'window_display',
-    'clipboard_read',
-    'clipboard_write',
-    'global_shortcuts',
-    'notifications',
-    'drag_drop',
-    'filesystem_roots',
-    'processes',
-    'file_dialogs',
-    'app_menu',
-    'task_dialogs',
-  ])
+  keys(data, SERVICE_POLICY_KEYS)
   const grant = (key: keyof ServicePolicy) => {
     if (typeof data[key] !== 'boolean')
       throw new ProtocolError('Native service policy must explicitly grant or deny each operation')
@@ -178,9 +187,11 @@ export function parseServicePolicy(value: unknown): ServicePolicy {
   }
 }
 
+const DISPLAY_SNAPSHOT_KEYS = fields('bounds', 'scale_factor', 'visible_bounds', 'display_uuid')
+
 export function parseDisplaySnapshot(value: unknown): DisplaySnapshot {
   const data = object(value)
-  keys(data, ['bounds', 'scale_factor', 'visible_bounds', 'display_uuid'])
+  keys(data, DISPLAY_SNAPSHOT_KEYS)
   const snapshot: DisplaySnapshot = {
     bounds: displayBounds(data['bounds'], 'display'),
     scale_factor: number(data['scale_factor'], 'display scale factor', 0.125, 16),

package/src/values.ts

@@ -10,9 +10,15 @@ export function object(value: unknown): Record<string, unknown> {
   return value as Record<string, unknown>
 }
 
-export function keys(value: Record<string, unknown>, allowed: readonly string[]): void {
+/** A message's accepted property names, hoisted to module scope so validation allocates nothing. */
+export function fields(...names: readonly string[]): ReadonlySet<string> {
+  return new Set(names)
+}
+
+/** Reject own enumerable properties outside `allowed`; inherited keys are ignored. */
+export function keys(value: Record<string, unknown>, allowed: ReadonlySet<string>): void {
   for (const key of Object.keys(value))
-    if (!allowed.includes(key)) throw new ProtocolError('Unknown message property: ' + key)
+    if (!allowed.has(key)) throw new ProtocolError('Unknown message property: ' + key)
 }
 
 export function number(value: unknown, field: string, min: number, max: number): number {