orient-cli 0.2.1 → 0.3.0

package/node_modules/mime-types/index.js

@@ -0,0 +1,211 @@
+/*!
+ * mime-types
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+'use strict'
+
+/**
+ * Module dependencies.
+ * @private
+ */
+
+var db = require('mime-db')
+var extname = require('path').extname
+var mimeScore = require('./mimeScore')
+
+/**
+ * Module variables.
+ * @private
+ */
+
+var EXTRACT_TYPE_REGEXP = /^\s*([^;\s]*)(?:;|\s|$)/
+var TEXT_TYPE_REGEXP = /^text\//i
+
+/**
+ * Module exports.
+ * @public
+ */
+
+exports.charset = charset
+exports.charsets = { lookup: charset }
+exports.contentType = contentType
+exports.extension = extension
+exports.extensions = Object.create(null)
+exports.lookup = lookup
+exports.types = Object.create(null)
+exports._extensionConflicts = []
+
+// Populate the extensions/types maps
+populateMaps(exports.extensions, exports.types)
+
+/**
+ * Get the default charset for a MIME type.
+ *
+ * @param {string} type
+ * @return {false|string}
+ */
+
+function charset (type) {
+  if (!type || typeof type !== 'string') {
+    return false
+  }
+
+  // TODO: use media-typer
+  var match = EXTRACT_TYPE_REGEXP.exec(type)
+  var mime = match && db[match[1].toLowerCase()]
+
+  if (mime && mime.charset) {
+    return mime.charset
+  }
+
+  // default text/* to utf-8
+  if (match && TEXT_TYPE_REGEXP.test(match[1])) {
+    return 'UTF-8'
+  }
+
+  return false
+}
+
+/**
+ * Create a full Content-Type header given a MIME type or extension.
+ *
+ * @param {string} str
+ * @return {false|string}
+ */
+
+function contentType (str) {
+  // TODO: should this even be in this module?
+  if (!str || typeof str !== 'string') {
+    return false
+  }
+
+  var mime = str.indexOf('/') === -1 ? exports.lookup(str) : str
+
+  if (!mime) {
+    return false
+  }
+
+  // TODO: use content-type or other module
+  if (mime.indexOf('charset') === -1) {
+    var charset = exports.charset(mime)
+    if (charset) mime += '; charset=' + charset.toLowerCase()
+  }
+
+  return mime
+}
+
+/**
+ * Get the default extension for a MIME type.
+ *
+ * @param {string} type
+ * @return {false|string}
+ */
+
+function extension (type) {
+  if (!type || typeof type !== 'string') {
+    return false
+  }
+
+  // TODO: use media-typer
+  var match = EXTRACT_TYPE_REGEXP.exec(type)
+
+  // get extensions
+  var exts = match && exports.extensions[match[1].toLowerCase()]
+
+  if (!exts || !exts.length) {
+    return false
+  }
+
+  return exts[0]
+}
+
+/**
+ * Lookup the MIME type for a file path/extension.
+ *
+ * @param {string} path
+ * @return {false|string}
+ */
+
+function lookup (path) {
+  if (!path || typeof path !== 'string') {
+    return false
+  }
+
+  // get the extension ("ext" or ".ext" or full path)
+  var extension = extname('x.' + path)
+    .toLowerCase()
+    .slice(1)
+
+  if (!extension) {
+    return false
+  }
+
+  return exports.types[extension] || false
+}
+
+/**
+ * Populate the extensions and types maps.
+ * @private
+ */
+
+function populateMaps (extensions, types) {
+  Object.keys(db).forEach(function forEachMimeType (type) {
+    var mime = db[type]
+    var exts = mime.extensions
+
+    if (!exts || !exts.length) {
+      return
+    }
+
+    // mime -> extensions
+    extensions[type] = exts
+
+    // extension -> mime
+    for (var i = 0; i < exts.length; i++) {
+      var extension = exts[i]
+      types[extension] = _preferredType(extension, types[extension], type)
+
+      // DELETE (eventually): Capture extension->type maps that change as a
+      // result of switching to mime-score.  This is just to help make reviewing
+      // PR #119 easier, and can be removed once that PR is approved.
+      const legacyType = _preferredTypeLegacy(
+        extension,
+        types[extension],
+        type
+      )
+      if (legacyType !== types[extension]) {
+        exports._extensionConflicts.push([extension, legacyType, types[extension]])
+      }
+    }
+  })
+}
+
+// Resolve type conflict using mime-score
+function _preferredType (ext, type0, type1) {
+  var score0 = type0 ? mimeScore(type0, db[type0].source) : 0
+  var score1 = type1 ? mimeScore(type1, db[type1].source) : 0
+
+  return score0 > score1 ? type0 : type1
+}
+
+// Resolve type conflict using pre-mime-score logic
+function _preferredTypeLegacy (ext, type0, type1) {
+  var SOURCE_RANK = ['nginx', 'apache', undefined, 'iana']
+
+  var score0 = type0 ? SOURCE_RANK.indexOf(db[type0].source) : 0
+  var score1 = type1 ? SOURCE_RANK.indexOf(db[type1].source) : 0
+
+  if (
+    exports.types[extension] !== 'application/octet-stream' &&
+    (score0 > score1 ||
+      (score0 === score1 &&
+        exports.types[extension]?.slice(0, 12) === 'application/'))
+  ) {
+    return type0
+  }
+
+  return score0 > score1 ? type0 : type1
+}

package/node_modules/mime-types/mimeScore.js

@@ -0,0 +1,57 @@
+// 'mime-score' back-ported to CommonJS
+
+// Score RFC facets (see https://tools.ietf.org/html/rfc6838#section-3)
+var FACET_SCORES = {
+  'prs.': 100,
+  'x-': 200,
+  'x.': 300,
+  'vnd.': 400,
+  default: 900
+}
+
+// Score mime source (Logic originally from `jshttp/mime-types` module)
+var SOURCE_SCORES = {
+  nginx: 10,
+  apache: 20,
+  iana: 40,
+  default: 30 // definitions added by `jshttp/mime-db` project?
+}
+
+var TYPE_SCORES = {
+  // prefer application/xml over text/xml
+  // prefer application/rtf over text/rtf
+  application: 1,
+
+  // prefer font/woff over application/font-woff
+  font: 2,
+
+  // prefer video/mp4 over audio/mp4 over application/mp4
+  // See https://www.rfc-editor.org/rfc/rfc4337.html#section-2
+  audio: 2,
+  video: 3,
+
+  default: 0
+}
+
+/**
+ * Get each component of the score for a mime type.  The sum of these is the
+ * total score.  The higher the score, the more "official" the type.
+ */
+module.exports = function mimeScore (mimeType, source = 'default') {
+  if (mimeType === 'application/octet-stream') {
+    return 0
+  }
+
+  const [type, subtype] = mimeType.split('/')
+
+  const facet = subtype.replace(/(\.|x-).*/, '$1')
+
+  const facetScore = FACET_SCORES[facet] || FACET_SCORES.default
+  const sourceScore = SOURCE_SCORES[source] || SOURCE_SCORES.default
+  const typeScore = TYPE_SCORES[type] || TYPE_SCORES.default
+
+  // All else being equal prefer shorter types
+  const lengthScore = 1 - mimeType.length / 100
+
+  return facetScore + sourceScore + typeScore + lengthScore
+}

package/node_modules/mime-types/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "mime-types",
+  "description": "The ultimate javascript content-type utility.",
+  "version": "3.0.2",
+  "contributors": [
+    "Douglas Christopher Wilson <doug@somethingdoug.com>",
+    "Jeremiah Senkpiel <fishrock123@rocketmail.com> (https://searchbeam.jit.su)",
+    "Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "mime",
+    "types"
+  ],
+  "repository": "jshttp/mime-types",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/express"
+  },
+  "dependencies": {
+    "mime-db": "^1.54.0"
+  },
+  "devDependencies": {
+    "eslint": "8.33.0",
+    "eslint-config-standard": "14.1.1",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-markdown": "3.0.1",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.6.0",
+    "eslint-plugin-standard": "4.1.0",
+    "mocha": "10.8.2",
+    "nyc": "15.1.0"
+  },
+  "files": [
+    "HISTORY.md",
+    "LICENSE",
+    "index.js",
+    "mimeScore.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha --reporter spec test/test.js",
+    "test-ci": "nyc --reporter=lcov --reporter=text npm test",
+    "test-cov": "nyc --reporter=html --reporter=text npm test"
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "orient-cli",
-	"version": "0.2.1",
-	"description": "ORIENT CLI — a spec-driven coding agent with dual modes. Plan/Execute for fast feature work, ORIENT framework for beast-mode spec-driven development. Forked from pi-mono.",
+	"version": "0.3.0",
+	"description": "ORIENT CLI — a spec-driven coding agent with dual modes, compass banner, tier-aware research, and built-in browser automation. Plan/Execute for fast feature work, ORIENT framework for beast-mode spec-driven development. Ships with @playwright/cli for browser tools and notebooklm-py for tier-3 Research.",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -14,6 +14,7 @@
 		"skills",
 		"prompts",
 		"docs",
+		"scripts/postinstall.mjs",
 		"README.md",
 		"NOTICE.md",
 		"LICENSE"
@@ -22,12 +23,15 @@
 		"dev": "tsc --watch --preserveWatchOutput",
 		"build": "tsc",
 		"clean": "rm -rf dist",
+		"postinstall": "node scripts/postinstall.mjs",
 		"prepublishOnly": "npm run clean && npm run build"
 	},
 	"dependencies": {
-		"@orient-cli/coding-agent": "^0.2.0",
-		"@orient-cli/agent-core": "^0.2.0",
-		"@orient-cli/ai": "^0.2.0",
+		"@orient-cli/coding-agent": "^0.3.0",
+		"@orient-cli/agent-core": "^0.3.0",
+		"@orient-cli/ai": "^0.3.0",
+		"@playwright/cli": "^0.1.7",
+		"playwright": "^1.60.0-alpha",
 		"@sinclair/typebox": "^0.34.0",
 		"@anthropic-ai/sdk": "^0.73.0",
 		"@aws-sdk/client-bedrock-runtime": "^3.983.0",
@@ -99,6 +103,9 @@
 		"llm",
 		"plan-execute",
 		"workflow",
-		"notebooklm"
+		"notebooklm",
+		"playwright",
+		"browser-automation",
+		"research"
 	]
 }

package/scripts/postinstall.mjs

@@ -0,0 +1,235 @@
+#!/usr/bin/env node
+/**
+ * orient-cli postinstall script
+ * ==============================
+ *
+ * Runs once after `npm install -g orient-cli` (or a local install that
+ * includes orient-cli as a dep). Fetches the two heavyweight integrations
+ * the CLI ships by default so users get a fully working install in one
+ * command:
+ *
+ *   1. Chromium browser binary via `npx playwright install chromium`
+ *      (~170 MB). Required by @playwright/cli, which ships as a regular
+ *      dependency. Without this, every browser tool fails with
+ *      "Executable doesn't exist".
+ *
+ *   2. `notebooklm-py[browser]` Python package via pip. Required by
+ *      tier-3 Research phase. The Python-side `playwright install
+ *      chromium` is ALSO run here so the notebooklm login flow (which
+ *      opens a headed browser) has the browser binary it needs when
+ *      the user eventually triggers it.
+ *
+ * The script is designed to degrade gracefully:
+ *
+ *   - Any failure (no Python, no pip, network error, missing perms,
+ *     etc.) is logged to stdout but does NOT block the orient-cli
+ *     install. Users can always re-run the bits they need via
+ *     `/orient.playwright.setup` and `/orient.research.setup` from
+ *     inside the CLI.
+ *
+ *   - `ORIENT_SKIP_POSTINSTALL=1` completely opts out — useful for CI
+ *     containers that do their own browser provisioning, and for air-
+ *     gapped installs. The two manual setup commands still work.
+ *
+ *   - `ORIENT_SKIP_PLAYWRIGHT=1` and `ORIENT_SKIP_NOTEBOOKLM=1` let
+ *     the user skip one integration without the other.
+ *
+ *   - npm's `--ignore-scripts` flag disables the whole thing the way
+ *     npm does for any postinstall hook.
+ *
+ * This script is intentionally pure Node with no extra dependencies so
+ * it runs before orient-cli's own node_modules have been constructed.
+ */
+
+import { spawn, spawnSync } from "node:child_process";
+import { existsSync } from "node:fs";
+
+const log = (msg) => process.stdout.write(`[orient-cli postinstall] ${msg}\n`);
+const warn = (msg) => process.stdout.write(`[orient-cli postinstall] ⚠ ${msg}\n`);
+
+// ============================================================================
+// Opt-outs
+// ============================================================================
+
+if (process.env.ORIENT_SKIP_POSTINSTALL === "1") {
+	log("ORIENT_SKIP_POSTINSTALL=1 — skipping all postinstall steps.");
+	log("Run /orient.playwright.setup and /orient.research.setup from inside orient later if you need them.");
+	process.exit(0);
+}
+
+// Skip inside CI if the caller hasn't explicitly opted in. CI
+// environments rarely want a 170 MB chromium download unless they
+// asked for it.
+if (process.env.CI && !process.env.ORIENT_FORCE_POSTINSTALL) {
+	log("CI=1 detected — skipping postinstall (set ORIENT_FORCE_POSTINSTALL=1 to override).");
+	process.exit(0);
+}
+
+// ============================================================================
+// Utilities
+// ============================================================================
+
+function which(binary) {
+	try {
+		const result = spawnSync(process.platform === "win32" ? "where" : "which", [binary], {
+			stdio: ["ignore", "pipe", "ignore"],
+		});
+		if (result.status === 0) {
+			const out = result.stdout.toString().trim();
+			return out.split(/\r?\n/)[0] || null;
+		}
+	} catch {
+		// Fall through.
+	}
+	return null;
+}
+
+function run(cmd, args, options = {}) {
+	return new Promise((resolve) => {
+		const proc = spawn(cmd, args, {
+			stdio: "inherit",
+			shell: process.platform === "win32",
+			...options,
+		});
+		proc.on("error", (err) => {
+			warn(`${cmd} ${args.join(" ")} failed to spawn: ${err.message}`);
+			resolve(false);
+		});
+		proc.on("close", (code) => resolve(code === 0));
+	});
+}
+
+function detectPython() {
+	for (const candidate of ["python3", "python"]) {
+		if (which(candidate)) return candidate;
+	}
+	return null;
+}
+
+function pipArgsFor(python) {
+	// `python -m pip` is the only invocation that's guaranteed to
+	// match the Python we detected. A standalone `pip` on PATH can
+	// point at a different interpreter.
+	return [python, "-m", "pip"];
+}
+
+// ============================================================================
+// Step 1 — Chromium via playwright (Node)
+// ============================================================================
+
+async function installChromium() {
+	if (process.env.ORIENT_SKIP_PLAYWRIGHT === "1") {
+		log("ORIENT_SKIP_PLAYWRIGHT=1 — skipping chromium install.");
+		return;
+	}
+
+	log("Installing Chromium browser binary (npx playwright install chromium, ~170 MB)…");
+	const ok = await run("npx", ["--yes", "playwright", "install", "chromium"]);
+	if (ok) {
+		log("✓ Chromium installed. `playwright-cli` browser tools are ready.");
+	} else {
+		warn(
+			"Chromium install failed. Run `npx playwright install chromium` manually, or `/orient.playwright.setup` from inside orient.",
+		);
+	}
+}
+
+// ============================================================================
+// Step 2 — notebooklm-py[browser] via pip (Python)
+// ============================================================================
+
+async function installNotebookLM() {
+	if (process.env.ORIENT_SKIP_NOTEBOOKLM === "1") {
+		log("ORIENT_SKIP_NOTEBOOKLM=1 — skipping notebooklm-py install.");
+		return;
+	}
+
+	const python = detectPython();
+	if (!python) {
+		warn(
+			"Python 3 not found on PATH. notebooklm-py install skipped — install Python 3.10+ and run `/orient.research.setup` from inside orient later.",
+		);
+		return;
+	}
+
+	const pip = pipArgsFor(python);
+	const pipCheck = spawnSync(pip[0], [...pip.slice(1), "--version"], { stdio: "ignore" });
+	if (pipCheck.status !== 0) {
+		warn(
+			`pip not available for ${python}. Install pip (e.g. \`sudo apt install python3-pip\`) and run \`/orient.research.setup\` from inside orient later.`,
+		);
+		return;
+	}
+
+	log(`Installing notebooklm-py[browser] via ${pip.join(" ")} install --user …`);
+	const pipOk = await run(pip[0], [...pip.slice(1), "install", "--user", "notebooklm-py[browser]"]);
+	if (!pipOk) {
+		warn(
+			"notebooklm-py install failed. Run `pip install --user 'notebooklm-py[browser]'` manually, or `/orient.research.setup` from inside orient.",
+		);
+		return;
+	}
+	log("✓ notebooklm-py[browser] installed.");
+
+	// notebooklm-py needs its own chromium for the login flow. This is
+	// the same binary the Node-side playwright already fetched above,
+	// but the Python-side playwright maintains its own cache, so we
+	// install it again explicitly. The download is deduplicated in
+	// most environments because Playwright's binary store is shared
+	// across language bindings in its default location.
+	log("Installing Chromium for notebooklm login flow (python -m playwright install chromium)…");
+	const pwOk = await run(python, ["-m", "playwright", "install", "chromium"]);
+	if (pwOk) {
+		log("✓ Chromium installed for Python-side playwright.");
+	} else {
+		warn(
+			"Python-side Chromium install failed — `notebooklm login` may fail until you run `python3 -m playwright install chromium` manually.",
+		);
+	}
+
+	log(
+		"notebooklm-py is installed but NOT yet authenticated. First sign-in happens automatically the first time you enter tier-3 Research in orient (or run `/orient.research.setup` manually).",
+	);
+}
+
+// ============================================================================
+// Main
+// ============================================================================
+
+async function main() {
+	log("Finalising orient-cli install — fetching browser + Python integrations…");
+	try {
+		await installChromium();
+	} catch (err) {
+		warn(`Chromium install errored: ${err?.message ?? err}`);
+	}
+	try {
+		await installNotebookLM();
+	} catch (err) {
+		warn(`notebooklm-py install errored: ${err?.message ?? err}`);
+	}
+
+	// Web search is reimplemented directly in orient-cli TypeScript
+	// (see packages/orient/src/integrations/web-search/) against the
+	// same playwright binary we just installed. No additional install
+	// step — the chromium browser fetched above is all it needs. We
+	// log the capability so the user knows it's live.
+	log("✓ Built-in web search ready (bing → brave → duckduckgo, no API keys, derived from mrkrsl/web-search-mcp pattern).");
+
+	log("");
+	log("orient-cli is ready. What now:");
+	log("  $ orient                          # start the dual-mode CLI");
+	log("  shift+tab                         # toggle Plan ↔ Execute in-session");
+	log("  /orient.framework                 # enter beast-mode spec-driven workflow");
+	log("  /orient.research.setup            # re-run the NotebookLM auth later");
+	log("  /orient.playwright.setup          # re-fetch chromium if needed");
+	log("");
+}
+
+main().catch((err) => {
+	// Never block the orient-cli install on a postinstall failure —
+	// the CLI itself is usable without these extras, they just need
+	// to be re-run from inside orient.
+	warn(`postinstall error: ${err?.message ?? err}`);
+	process.exit(0);
+});