feat(npm): add npm package publishing with CLI entry point

[diegosouzapw]

Changes

• bin/omniroute.mjs — CLI entry point with banner, auto-open browser, graceful shutdown
• scripts/prepublish.mjs — Build script to generate Next.js standalone in app/
• .github/workflows/npm-publish.yml — Auto-publish to npm on GitHub Release
• package.json — name=omniroute, bin, files, engines, keywords, prepublishOnly
• next.config.mjs — Added output: 'standalone'
• LICENSE — MIT
• .npmignore / .gitignore — Updated for app/ build artifact

Usage after publish

npm install -g omniroute
omniroute

Auto-publish workflow

When creating a GitHub Release (e.g. v0.1.0), npm publish runs automatically via GitHub Actions.

[github-actions]

@codex review

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

[chatgpt-codex-connector]

To use Codex here, create a Codex account and connect to github.

[Copilot]

Pull request overview

This PR adds npm package publishing capabilities to OmniRoute, transforming it from a development-only project into an installable CLI tool. The implementation uses Next.js standalone mode to create a self-contained build that can be globally installed via npm.

Changes:

• Added CLI entry point (bin/omniroute.mjs) with server lifecycle management, argument parsing, and auto-browser opening
• Created build script (scripts/prepublish.mjs) to generate Next.js standalone output and copy runtime dependencies to app/ directory
• Configured automated npm publishing via GitHub Actions workflow triggered on release creation
• Updated package metadata for public npm distribution with proper bin configuration, files array, and keywords
• Enabled Next.js standalone mode and improved environment variable handling
• Added MIT license and updated ignore files for build artifacts

Reviewed changes

Copilot reviewed 6 out of 9 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
bin/omniroute.mjs	CLI entry point that spawns Next.js standalone server with banner, port configuration, graceful shutdown, and browser auto-open
scripts/prepublish.mjs	Build script that creates standalone Next.js build, copies static assets, MITM utilities, and shared dependencies to publishable app/ directory
package.json	Updated package name to "omniroute", added bin entry, files array, engines requirement, keywords, license, and prepublishOnly hook
package-lock.json	Reflects package.json changes including name, version, license, bin, engines, and marks fsevents as dev dependency
next.config.mjs	Enabled standalone output mode for npm packaging and removed hardcoded NEXT_PUBLIC_CLOUD_URL in favor of .env configuration
.github/workflows/npm-publish.yml	Automated npm publishing on GitHub release with version sync, standalone build, and provenance
LICENSE	Added MIT license with 2026 copyright
.npmignore	Configured to exclude source files and include only bin/ and app/ directories in published package
.gitignore	Added /app directory to ignore list since it's a build artifact

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The build script creates an empty data/ directory in the published package. When users install via npm, this directory will be in their global npm packages directory (e.g., /usr/local/lib/node_modules/omniroute/app/data/), which may not have write permissions for all users. The application should handle the case where this directory is not writable and potentially use a user-specific data directory (e.g., ~/.omniroute/data/ or respect the DATA_DIR environment variable from .env.example). Verify that the application properly handles data directory initialization and permissions at runtime.

Suggested change

	// ── Step 10: Ensure data/ directory exists ──────────────────
	mkdirSync(join(APP_DIR, "data"), { recursive: true });
	// ── Note: data/ directory is initialized at runtime ────────
	// Do not create a writable data/ directory inside app/ here, as it
	// would reside in a potentially non-writable global npm directory.

[Copilot]

The package.json excludes scripts/ in the .npmignore but includes scripts/prepublish.mjs that won't be in the published package. This is intentional since the build script is only needed during the publishing process (via prepublishOnly), not after installation. However, consider adding a comment in package.json or the build script explaining that prepublishOnly runs before publishing to npm, not during user installation, to clarify the build workflow.

Suggested change

	logs/
	logs/
	# Note: scripts/ (e.g. scripts/prepublish.mjs) is only used during npm publish via `prepublishOnly`,
	# so it is intentionally excluded from the published package.

[Copilot]

The workflow uses Node.js 22, but the package.json specifies engines.node: ">=18.0.0". While this is not necessarily wrong (testing on a higher version that still meets the minimum requirement), consider whether the package should be tested on Node.js 18 as well to ensure compatibility with the minimum supported version, especially since users might install it on Node.js 18.

Suggested change

	node-version: 22
	node-version: 18

[Copilot]

The build script uses execSync with stdio: "inherit" but doesn't wrap it in try-catch blocks. If any command fails (npm install, next build), the script will crash with an unhandled exception. While this might be acceptable since the process should exit on build failure anyway, consider adding try-catch blocks with clearer error messages to help diagnose build failures, especially for the critical Next.js build step.

[Copilot]

The .npmignore excludes all .env* files including .env.example. Users installing the package via npm won't have a reference for required environment variables. Consider either: (1) including .env.example in the published package by adding !.env.example to .npmignore, (2) documenting required environment variables in the README, or (3) having the CLI create a default configuration on first run. This is especially important for variables like JWT_SECRET, INITIAL_PASSWORD, and DATA_DIR from the .env.example file.

Suggested change

	eslint.config.mjs
	prettier.config.mjs
	postcss.config.mjs
	!.env.example
	eslint.config.mjs
	prettier.config.mjs

[Copilot]

The workflow synchronizes the version from the GitHub release tag, which overwrites the version in package.json. This means the version "0.1.0" in package.json is only a placeholder and will be replaced during publishing. Consider adding a comment in package.json near the version field to clarify that the actual version is set from the GitHub release tag during publishing, to avoid confusion for maintainers.

Suggested change

	echo "Publishing version: $VERSION"
	echo "Publishing version (from GitHub release tag, overriding package.json placeholder): $VERSION"

[Copilot]

The .npmignore file excludes the open-sse/ workspace directory, which might cause issues if the Next.js standalone build doesn't properly bundle this workspace dependency. Verify that @omniroute/open-sse is correctly included in the standalone output at .next/standalone/node_modules/@omniroute/open-sse or adjust the build script to explicitly copy it. The transpilePackages configuration in next.config.mjs should handle this, but it should be tested to ensure the published package works correctly.

Suggested change

open-sse/

[Copilot]

The writeFileSync import is unused in this script. It's imported on line 13 but never called. Consider removing it to keep the imports clean.

Suggested change

	import { existsSync, mkdirSync, cpSync, rmSync, writeFileSync, readFileSync } from "node:fs";
	import { existsSync, mkdirSync, cpSync, rmSync, readFileSync } from "node:fs";

[Copilot]

The files array in package.json includes app/ which will contain the standalone Next.js build and all dependencies. Verify that this directory doesn't accidentally include large or unnecessary files that could bloat the package size. The standalone build typically includes node_modules, but only production dependencies. Consider checking the final package size before publishing and potentially adding more exclusions to .npmignore if needed.

Suggested change

	"app/",
	"app/.next/standalone/",