automify 0.1.0 → 0.1.2

package/README.md

@@ -34,7 +34,7 @@ OpenAI and Anthropic models are supported, and any other model can be plugged in
 - Built-in OpenAI and Anthropic support, plus custom model adapters.
 - Practical guardrails: domain allowlists, command policies, screenshot controls, max steps, and hooks.
 
-Full docs live in [`docs/documentation.html`](docs/documentation.html). The shorter argument reference is [`docs/argument-reference.md`](docs/argument-reference.md).
+Full docs live at [aldovincenti.github.io/automify](https://aldovincenti.github.io/automify/). The shorter argument reference is [`docs/argument-reference.md`](docs/argument-reference.md).
 
 ## Install
 
@@ -50,6 +50,14 @@ AUTOMIFY_SKIP_BROWSER_INSTALL=1 npm install automify
 
 Requirements: Node.js `18.18+` and a provider config. OpenAI examples use `gpt-5.5`.
 
+Automify is published as an ES module package, so the examples use modern `import` syntax:
+
+```js
+import { initAutomify } from "automify";
+```
+
+Use this from an ES module project (`"type": "module"` in `package.json`) or from `.mjs` files. In CommonJS projects, use dynamic `import()` from your `require`-based files instead.
+
 Zod support is optional. Install Zod only if you want to build structured outputs from Zod schemas:
 
 ```bash
@@ -190,10 +198,10 @@ try {
 
 ### Desktop Computer Use
 
-Local desktop computer use is optional because OS control needs permissions:
+Local desktop computer use is optional. Install it with the command below; it may take a while because it compiles native desktop dependencies. When you use the local desktop adapter, your OS may ask for permission to control the desktop.
 
 ```bash
-npm run install:desktop
+npx automify-install-desktop
 ```
 
 ```js
@@ -396,6 +404,27 @@ npm run test:e2e
 OPENAI_API_KEY=... npm run test:live
 ```
 
+`npm run test:live` runs `test/e2e/live-openai.e2e.test.js` with `RUN_OPENAI_E2E=1`. By default, it runs the live OpenAI CLI and Docker CLI checks and skips the browser and Docker desktop checks.
+
+Run every live test:
+
+```bash
+OPENAI_API_KEY=... \
+RUN_OPENAI_BROWSER_E2E=1 \
+RUN_OPENAI_VIRTUAL_DESKTOP_E2E=1 \
+npm run test:live
+```
+
+The equivalent direct command is:
+
+```bash
+OPENAI_API_KEY=... \
+RUN_OPENAI_E2E=1 \
+RUN_OPENAI_BROWSER_E2E=1 \
+RUN_OPENAI_VIRTUAL_DESKTOP_E2E=1 \
+node --test test/e2e/live-openai.e2e.test.js
+```
+
 ## License
 
 MIT

package/examples/custom-computer.js

@@ -1,6 +1,6 @@
 import { createLocalDesktopComputer, initAutomify } from "../src/index.js";
 
-// Run `npm run install:desktop` once before using createLocalDesktopComputer().
+// Run `npx automify-install-desktop` once before using createLocalDesktopComputer().
 const automify = initAutomify({
   provider: {
     type: "openai",

package/examples/desktop-local.js

@@ -3,7 +3,7 @@ import { tmpdir } from "node:os";
 
 import { createLocalDesktopComputer, initAutomify } from "../src/index.js";
 
-// Run `npm run install:desktop` once before using createLocalDesktopComputer().
+// Run `npx automify-install-desktop` once before using createLocalDesktopComputer().
 const automify = initAutomify({
   provider: {
     type: "openai",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "automify",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "AI computer use for browser, CLI, and desktop in Node.js.",
   "homepage": "https://aldovincenti.github.io/automify",
   "bugs": {
@@ -13,6 +13,9 @@
   "type": "module",
   "main": "src/index.js",
   "types": "src/index.d.ts",
+  "bin": {
+    "automify-install-desktop": "./scripts/install-desktop.js"
+  },
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
@@ -43,7 +46,9 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "jimp": "^0.22.10",
+    "@jimp/core": "^1.6.1",
+    "@jimp/js-png": "^1.6.1",
+    "@jimp/plugin-resize": "^1.6.1",
     "playwright": ">=1.40.0"
   },
   "peerDependencies": {

package/scripts/install-browser.js

@@ -1,10 +1,15 @@
 import { spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+
+const require = createRequire(import.meta.url);
 
 if (process.env.AUTOMIFY_SKIP_BROWSER_INSTALL === "1" || process.env.PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD === "1") {
   process.exit(0);
 }
 
-const result = spawnSync(process.execPath, ["node_modules/playwright/cli.js", "install", "chromium"], {
+const playwrightCli = join(dirname(require.resolve("playwright")), "cli.js");
+const result = spawnSync(process.execPath, [playwrightCli, "install", "chromium"], {
   cwd: process.cwd(),
   stdio: "inherit"
 });

package/scripts/install-desktop.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { spawnSync } from "node:child_process";
 import { cpSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
@@ -23,7 +24,9 @@ const platformPackageDir = join(nutScope, `libnut-${process.platform}`);
 const macPermissionsPackageDir = join(nutScope, "node-mac-permissions");
 
 const runtimeDependencies = [
-  "jimp@0.22.10",
+  "@jimp/core@1.6.1",
+  "@jimp/js-png@1.6.1",
+  "@jimp/plugin-resize@1.6.1",
   "node-abort-controller@3.1.1",
   "clipboardy@2.3.0",
   "bindings@1.5.0"
@@ -123,7 +126,7 @@ function checkBuildPrerequisites() {
   if (missing.length === 0) return;
 
   console.error(`Missing required desktop build tool(s): ${missing.join(", ")}`);
-  console.error("Install the native build prerequisites, then rerun: npm run install:desktop");
+  console.error("Install the native build prerequisites, then rerun: npx automify-install-desktop");
 
   if (process.platform === "darwin") {
     console.error("macOS: install Xcode Command Line Tools with `xcode-select --install` and install CMake.");

package/src/lib/automify.js

@@ -715,10 +715,15 @@ async function resizeScreenshot(screenshot, target, options, automify) {
   }
 
   try {
-    const { default: Jimp } = await import("jimp");
+    const [{ createJimp }, png, resize] = await Promise.all([
+      import("@jimp/core"),
+      import("@jimp/js-png"),
+      import("@jimp/plugin-resize")
+    ]);
+    const Jimp = createJimp({ formats: [png.default], plugins: [resize.methods] });
     const image = await Jimp.read(Buffer.from(screenshot));
-    image.resize(target.width, target.height);
-    return image.getBufferAsync(Jimp.MIME_PNG);
+    image.resize({ w: target.width, h: target.height });
+    return image.getBuffer("image/png");
   } catch (error) {
     debugLog(automify.debug, "automify", "screenshot_resize_skipped", {
       reason: error?.message,

package/src/lib/local-desktop-computer.js

@@ -432,7 +432,7 @@ async function importNut() {
     return await import("@nut-tree/nut-js");
   } catch (error) {
     throw new AutomifyError(
-      "createLocalDesktopComputer requires the local desktop adapter dependency built from source. Install it with: npm run install:desktop",
+      "createLocalDesktopComputer requires the local desktop adapter dependency built from source. Install it with: npx automify-install-desktop",
       { cause: error }
     );
   }