pi-image-tools 1.3.0 → 1.4.0

package/src/providers/mac-osascript-publicpng.ts

@@ -1,11 +1,4 @@
-import { buildNamespaceWrappedCommand, defaultCommandExists, type CommandExists } from "../shell-environment.js";
-import {
-  defaultCommandRunner,
-  MAX_BUFFER_BYTES,
-  READ_TIMEOUT_MS,
-  type CommandRunner,
-} from "./command-runner.js";
-import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
+import { NamespacedCommandProvider, providerImageResult, type ClipboardReadResult, type CommandExists, type CommandResult, type CommandRunner } from "./provider-helpers.js";
 
 const PUBLIC_PNG_SCRIPT = `ObjC.import('AppKit');
 const pasteboard = $.NSPasteboard.generalPasteboard;
@@ -21,57 +14,25 @@ export interface OsascriptPublicPngProviderOptions {
   commandExists?: CommandExists;
 }
 
-export class OsascriptPublicPngProvider implements ClipboardImageProvider {
-  readonly capabilities;
-  private readonly commandRunner: CommandRunner;
-  private readonly commandExists: CommandExists;
-
+export class OsascriptPublicPngProvider extends NamespacedCommandProvider {
   constructor(options: OsascriptPublicPngProviderOptions = {}) {
-    this.capabilities = {
-      id: "mac-osascript-public-png",
-      name: "osascript public.png",
-      platforms: ["darwin"],
-      priority: options.priority ?? 20,
-    };
-    this.commandRunner = options.commandRunner ?? defaultCommandRunner;
-    this.commandExists = options.commandExists ?? defaultCommandExists;
-  }
-
-  isAvailable(context: ClipboardProviderContext): boolean {
-    try {
-      return this.commandExists("osascript", context);
-    } catch {
-      return false;
-    }
-  }
-
-  read(context: ClipboardProviderContext): ClipboardReadResult {
-    const wrapped = buildNamespaceWrappedCommand(
+    super(
+      {
+        id: "mac-osascript-public-png",
+        name: "osascript public.png",
+        platforms: ["darwin"],
+        priority: options.priority ?? 20,
+      },
       "osascript",
-      ["-l", "JavaScript", "-e", PUBLIC_PNG_SCRIPT],
-      context,
-      this.commandExists,
+      options,
     );
-    const result = this.commandRunner(wrapped.command, wrapped.args, {
-      environment: context.environment,
-      maxBuffer: MAX_BUFFER_BYTES,
-      timeout: READ_TIMEOUT_MS,
-    });
-
-    if (result.missingCommand) {
-      return { available: false, image: null };
-    }
+  }
 
-    if (!result.ok || result.stdout.length === 0) {
-      return { available: true, image: null };
-    }
+  protected buildArgs(): readonly string[] {
+    return ["-l", "JavaScript", "-e", PUBLIC_PNG_SCRIPT];
+  }
 
-    return {
-      available: true,
-      image: {
-        bytes: new Uint8Array(result.stdout),
-        mimeType: "image/png",
-      },
-    };
+  protected readFromResult(result: CommandResult): ClipboardReadResult {
+    return providerImageResult(new Uint8Array(result.stdout), "image/png");
   }
 }

package/src/providers/mac-pngpaste.ts

@@ -1,11 +1,4 @@
-import { buildNamespaceWrappedCommand, defaultCommandExists, type CommandExists } from "../shell-environment.js";
-import {
-  defaultCommandRunner,
-  MAX_BUFFER_BYTES,
-  READ_TIMEOUT_MS,
-  type CommandRunner,
-} from "./command-runner.js";
-import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
+import { NamespacedCommandProvider, providerImageResult, type ClipboardReadResult, type CommandExists, type CommandResult, type CommandRunner } from "./provider-helpers.js";
 
 export interface PngpasteProviderOptions {
   priority?: number;
@@ -13,57 +6,25 @@ export interface PngpasteProviderOptions {
   commandExists?: CommandExists;
 }
 
-export class PngpasteProvider implements ClipboardImageProvider {
-  readonly capabilities;
-  private readonly commandRunner: CommandRunner;
-  private readonly commandExists: CommandExists;
-
+export class PngpasteProvider extends NamespacedCommandProvider {
   constructor(options: PngpasteProviderOptions = {}) {
-    this.capabilities = {
-      id: "mac-pngpaste",
-      name: "pngpaste",
-      platforms: ["darwin"],
-      priority: options.priority ?? 10,
-    };
-    this.commandRunner = options.commandRunner ?? defaultCommandRunner;
-    this.commandExists = options.commandExists ?? defaultCommandExists;
-  }
-
-  isAvailable(context: ClipboardProviderContext): boolean {
-    try {
-      return this.commandExists("pngpaste", context);
-    } catch {
-      return false;
-    }
-  }
-
-  read(context: ClipboardProviderContext): ClipboardReadResult {
-    const wrapped = buildNamespaceWrappedCommand(
+    super(
+      {
+        id: "mac-pngpaste",
+        name: "pngpaste",
+        platforms: ["darwin"],
+        priority: options.priority ?? 10,
+      },
       "pngpaste",
-      ["-"],
-      context,
-      this.commandExists,
+      options,
     );
-    const result = this.commandRunner(wrapped.command, wrapped.args, {
-      environment: context.environment,
-      maxBuffer: MAX_BUFFER_BYTES,
-      timeout: READ_TIMEOUT_MS,
-    });
-
-    if (result.missingCommand) {
-      return { available: false, image: null };
-    }
+  }
 
-    if (!result.ok || result.stdout.length === 0) {
-      return { available: true, image: null };
-    }
+  protected buildArgs(): readonly string[] {
+    return ["-"];
+  }
 
-    return {
-      available: true,
-      image: {
-        bytes: new Uint8Array(result.stdout),
-        mimeType: "image/png",
-      },
-    };
+  protected readFromResult(result: CommandResult): ClipboardReadResult {
+    return providerImageResult(new Uint8Array(result.stdout), "image/png");
   }
 }

package/src/providers/native-module.ts

@@ -1,84 +1,84 @@
-import { createRequire } from "node:module";
-
-import { hasGraphicalSession } from "../shell-environment.js";
-import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
-import type { ClipboardModule } from "../types.js";
-
-const require = createRequire(import.meta.url);
-let cachedClipboardModule: ClipboardModule | null | undefined;
-
-export type ClipboardModuleLoader = (
-  platform: NodeJS.Platform,
-  environment: NodeJS.ProcessEnv,
-) => ClipboardModule | null;
-
-export function loadClipboardModule(
-  platform: NodeJS.Platform = process.platform,
-  environment: NodeJS.ProcessEnv = process.env,
-): ClipboardModule | null {
-  if (cachedClipboardModule !== undefined) {
-    return cachedClipboardModule;
-  }
-
-  if (environment.TERMUX_VERSION || !hasGraphicalSession(platform, environment)) {
-    cachedClipboardModule = null;
-    return cachedClipboardModule;
-  }
-
-  try {
-    cachedClipboardModule = require("@mariozechner/clipboard") as ClipboardModule;
-  } catch {
-    cachedClipboardModule = null;
-  }
-
-  return cachedClipboardModule;
-}
-
-export interface NativeModuleProviderOptions {
-  priority?: number;
-  moduleLoader?: ClipboardModuleLoader;
-}
-
-export class NativeModuleProvider implements ClipboardImageProvider {
-  readonly capabilities;
-  private readonly moduleLoader: ClipboardModuleLoader;
-
-  constructor(options: NativeModuleProviderOptions = {}) {
-    this.capabilities = {
-      id: "native-module",
-      name: "@mariozechner/clipboard",
-      platforms: "*" as const,
-      priority: options.priority ?? 100,
-    };
-    this.moduleLoader = options.moduleLoader ?? loadClipboardModule;
-  }
-
-  isAvailable(context: ClipboardProviderContext): boolean {
-    return this.moduleLoader(context.platform, context.environment) !== null;
-  }
-
-  async read(context: ClipboardProviderContext): Promise<ClipboardReadResult> {
-    const clipboard = this.moduleLoader(context.platform, context.environment);
-    if (!clipboard) {
-      return { available: false, image: null };
-    }
-
-    if (!clipboard.hasImage()) {
-      return { available: true, image: null };
-    }
-
-    const imageData = await clipboard.getImageBinary();
-    if (!imageData || imageData.length === 0) {
-      return { available: true, image: null };
-    }
-
-    const bytes = imageData instanceof Uint8Array ? imageData : Uint8Array.from(imageData);
-    return {
-      available: true,
-      image: {
-        bytes,
-        mimeType: "image/png",
-      },
-    };
-  }
-}
+import { createRequire } from "node:module";
+
+import { hasGraphicalSession } from "../shell-environment.js";
+import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
+import type { ClipboardModule } from "../types.js";
+
+const require = createRequire(import.meta.url);
+let cachedClipboardModule: ClipboardModule | null | undefined;
+
+export type ClipboardModuleLoader = (
+  platform: NodeJS.Platform,
+  environment: NodeJS.ProcessEnv,
+) => ClipboardModule | null;
+
+export function loadClipboardModule(
+  platform: NodeJS.Platform = process.platform,
+  environment: NodeJS.ProcessEnv = process.env,
+): ClipboardModule | null {
+  if (cachedClipboardModule !== undefined) {
+    return cachedClipboardModule;
+  }
+
+  if (environment.TERMUX_VERSION || !hasGraphicalSession(platform, environment)) {
+    cachedClipboardModule = null;
+    return cachedClipboardModule;
+  }
+
+  try {
+    cachedClipboardModule = require("@mariozechner/clipboard") as ClipboardModule;
+  } catch {
+    cachedClipboardModule = null;
+  }
+
+  return cachedClipboardModule;
+}
+
+export interface NativeModuleProviderOptions {
+  priority?: number;
+  moduleLoader?: ClipboardModuleLoader;
+}
+
+export class NativeModuleProvider implements ClipboardImageProvider {
+  readonly capabilities;
+  private readonly moduleLoader: ClipboardModuleLoader;
+
+  constructor(options: NativeModuleProviderOptions = {}) {
+    this.capabilities = {
+      id: "native-module",
+      name: "@mariozechner/clipboard",
+      platforms: "*" as const,
+      priority: options.priority ?? 100,
+    };
+    this.moduleLoader = options.moduleLoader ?? loadClipboardModule;
+  }
+
+  isAvailable(context: ClipboardProviderContext): boolean {
+    return this.moduleLoader(context.platform, context.environment) !== null;
+  }
+
+  async read(context: ClipboardProviderContext): Promise<ClipboardReadResult> {
+    const clipboard = this.moduleLoader(context.platform, context.environment);
+    if (!clipboard) {
+      return { available: false, image: null };
+    }
+
+    if (!clipboard.hasImage()) {
+      return { available: true, image: null };
+    }
+
+    const imageData = await clipboard.getImageBinary();
+    if (!imageData || imageData.length === 0) {
+      return { available: true, image: null };
+    }
+
+    const bytes = imageData instanceof Uint8Array ? imageData : Uint8Array.from(imageData);
+    return {
+      available: true,
+      image: {
+        bytes,
+        mimeType: "image/png",
+      },
+    };
+  }
+}

package/src/providers/powershell-forms.ts

@@ -1,95 +1,87 @@
-import { runPowerShellCommand, type PowerShellCommandResult, type RunPowerShellCommandOptions } from "../powershell.js";
-import { MAX_BUFFER_BYTES, READ_TIMEOUT_MS } from "./command-runner.js";
-import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
-
-export type PowerShellRunner = (
-  script: string,
-  options: RunPowerShellCommandOptions,
-) => PowerShellCommandResult;
-
-export interface PowerShellFormsProviderOptions {
-  priority?: number;
-  powerShellRunner?: PowerShellRunner;
-}
-
-const READ_IMAGE_SCRIPT = `
-$ErrorActionPreference = 'Stop'
-Add-Type -AssemblyName System.Windows.Forms
-Add-Type -AssemblyName System.Drawing
-
-if (-not [System.Windows.Forms.Clipboard]::ContainsImage()) {
-  return
-}
-
-$image = [System.Windows.Forms.Clipboard]::GetImage()
-if ($null -eq $image) {
-  return
-}
-
-$stream = New-Object System.IO.MemoryStream
-try {
-  $image.Save($stream, [System.Drawing.Imaging.ImageFormat]::Png)
-  [System.Convert]::ToBase64String($stream.ToArray())
-} finally {
-  $stream.Dispose()
-  $image.Dispose()
-}
-`;
-
-export class PowerShellFormsProvider implements ClipboardImageProvider {
-  readonly capabilities;
-  private readonly powerShellRunner: PowerShellRunner;
-
-  constructor(options: PowerShellFormsProviderOptions = {}) {
-    this.capabilities = {
-      id: "powershell-forms",
-      name: "Windows PowerShell Forms clipboard",
-      platforms: ["win32"],
-      priority: options.priority ?? 20,
-    };
-    this.powerShellRunner = options.powerShellRunner ?? runPowerShellCommand;
-  }
-
-  isAvailable(_context: ClipboardProviderContext): boolean {
-    return true;
-  }
-
-  read(_context: ClipboardProviderContext): ClipboardReadResult {
-    const result = this.powerShellRunner(READ_IMAGE_SCRIPT, {
-      encoded: true,
-      maxBuffer: MAX_BUFFER_BYTES,
-      sta: true,
-      timeout: READ_TIMEOUT_MS,
-    });
-
-    if (result.missingCommand) {
-      return { available: false, image: null };
-    }
-
-    if (!result.ok) {
-      return { available: true, image: null };
-    }
-
-    const base64 = result.stdout.trim();
-    if (!base64) {
-      return { available: true, image: null };
-    }
-
-    try {
-      const bytes = Buffer.from(base64, "base64");
-      if (bytes.length === 0) {
-        return { available: true, image: null };
-      }
-
-      return {
-        available: true,
-        image: {
-          bytes: new Uint8Array(bytes),
-          mimeType: "image/png",
-        },
-      };
-    } catch {
-      return { available: true, image: null };
-    }
-  }
-}
+import { runPowerShellCommand, type PowerShellCommandResult, type RunPowerShellCommandOptions } from "../powershell.js";
+import { MAX_BUFFER_BYTES, READ_TIMEOUT_MS } from "./command-runner.js";
+import { mapProviderReadFallback, providerEmptyImage, providerImageResult } from "./provider-helpers.js";
+import type { ClipboardImageProvider, ClipboardProviderContext, ClipboardReadResult } from "./types.js";
+
+export type PowerShellRunner = (
+  script: string,
+  options: RunPowerShellCommandOptions,
+) => PowerShellCommandResult;
+
+export interface PowerShellFormsProviderOptions {
+  priority?: number;
+  powerShellRunner?: PowerShellRunner;
+}
+
+const READ_IMAGE_SCRIPT = `
+$ErrorActionPreference = 'Stop'
+Add-Type -AssemblyName System.Windows.Forms
+Add-Type -AssemblyName System.Drawing
+
+if (-not [System.Windows.Forms.Clipboard]::ContainsImage()) {
+  return
+}
+
+$image = [System.Windows.Forms.Clipboard]::GetImage()
+if ($null -eq $image) {
+  return
+}
+
+$stream = New-Object System.IO.MemoryStream
+try {
+  $image.Save($stream, [System.Drawing.Imaging.ImageFormat]::Png)
+  [System.Convert]::ToBase64String($stream.ToArray())
+} finally {
+  $stream.Dispose()
+  $image.Dispose()
+}
+`;
+
+export class PowerShellFormsProvider implements ClipboardImageProvider {
+  readonly capabilities;
+  private readonly powerShellRunner: PowerShellRunner;
+
+  constructor(options: PowerShellFormsProviderOptions = {}) {
+    this.capabilities = {
+      id: "powershell-forms",
+      name: "Windows PowerShell Forms clipboard",
+      platforms: ["win32"],
+      priority: options.priority ?? 20,
+    };
+    this.powerShellRunner = options.powerShellRunner ?? runPowerShellCommand;
+  }
+
+  isAvailable(_context: ClipboardProviderContext): boolean {
+    return true;
+  }
+
+  read(_context: ClipboardProviderContext): ClipboardReadResult {
+    const result = this.powerShellRunner(READ_IMAGE_SCRIPT, {
+      encoded: true,
+      maxBuffer: MAX_BUFFER_BYTES,
+      sta: true,
+      timeout: READ_TIMEOUT_MS,
+    });
+
+    const fallback = mapProviderReadFallback(result, false);
+    if (fallback) {
+      return fallback;
+    }
+
+    const base64 = result.stdout.trim();
+    if (!base64) {
+      return providerEmptyImage();
+    }
+
+    try {
+      const bytes = Buffer.from(base64, "base64");
+      if (bytes.length === 0) {
+        return providerEmptyImage();
+      }
+
+      return providerImageResult(new Uint8Array(bytes), "image/png");
+    } catch {
+      return providerEmptyImage();
+    }
+  }
+}