@linxiraos/pi-natives 1.0.0

package/README.md

@@ -0,0 +1,80 @@
+# @linxiraos/pi-natives
+
+Native Rust functionality via N-API.
+
+## What's Inside
+
+- **Grep**: Regex-based search powered by ripgrep's engine with native file walking and matching
+- **Find**: Glob-based file/directory discovery with gitignore support (pure TypeScript via `globPaths`)
+- **SIXEL**: Terminal image encoding for SIXEL-capable terminals (decode, resize, encode in one pass)
+- **Audio**: Cross-platform low-latency microphone capture and gapless speaker playback
+- **WebRTC**: Native Opus media, SDP offer/answer negotiation, and data-channel events for live sessions
+- **File locking**: Process-owned cross-process locks with in-memory kernel names on Linux/Windows and `flock(2)` sidecars on other Unix platforms
+
+General-purpose image processing (decode/resize/encode for files and buffers)
+lives in [`Bun.Image`](https://bun.com/docs/runtime/image) on the JS side; this
+crate only ships the SIXEL encoder because no built-in equivalent exists for
+that terminal protocol.
+
+## Usage
+
+```typescript
+import { grep, find, encodeSixel } from "@linxiraos/pi-natives";
+
+// Grep for a pattern
+const results = await grep({
+	pattern: "TODO",
+	path: "/path/to/project",
+	glob: "*.ts",
+	context: 2,
+});
+
+// Find files
+const files = await find({
+	pattern: "*.rs",
+	path: "/path/to/project",
+	fileType: "file",
+});
+
+// SIXEL encode for a terminal cell box (px)
+const sequence = encodeSixel(pngBytes, widthPx, heightPx);
+```
+
+## Building
+
+```bash
+# Build native addon from workspace root (requires Rust)
+bun run build
+
+# Type check
+bun run check
+```
+
+## Architecture
+
+`@linxiraos/pi-natives` publishes a small core package plus generated
+platform-specific optional dependency packages:
+
+```
+crates/pi-natives/       # Rust source (workspace member)
+  src/lib.rs             # N-API exports
+  src/sixel.rs           # SIXEL terminal-image encoding
+  Cargo.toml             # Rust dependencies
+native/                  # Core loader files and local/CI native build outputs
+  index.js               # Public native export surface
+  loader-state.js        # Platform, ISA variant, and addon resolution
+  embedded-addon.js      # Standalone binary embed stub/generated metadata
+  pi_natives.<platform>-<arch>-modern.node   # x64 modern ISA (local/CI artifact)
+  pi_natives.<platform>-<arch>-baseline.node # x64 baseline ISA (local/CI artifact)
+  pi_natives.<platform>-<arch>.node          # non-x64 build artifact
+npm/<platform>-<arch>/   # Generated at publish time, not committed
+  package.json           # @linxiraos/pi-natives-<platform>-<arch>
+  *.node                 # Only that platform's addon binary or x64 ISA variants
+```
+
+The published core package contains only the JS loader, declarations, README,
+and `package.json`. Release publishing generates one leaf package per supported
+`os`/`cpu` pair and injects those leaves into the core manifest as pinned
+`optionalDependencies`, so package managers install only the host platform's
+native addon. x64 leaves include every built ISA variant, and the loader keeps
+choosing between `baseline` and `modern` at runtime.

package/native/clipboard.d.ts

@@ -0,0 +1,9 @@
+import type { ClipboardImage } from "./index.js";
+
+export type { ClipboardImage } from "./index.js";
+
+/** Copy text to the clipboard, loading the native addon on first use. */
+export declare function copyToClipboard(text: string): void;
+
+/** Read an image from the clipboard, loading the native addon on first use. */
+export declare function readImageFromClipboard(): Promise<ClipboardImage | undefined | null>;

package/native/clipboard.js

@@ -0,0 +1,11 @@
+import { loadNative } from "./loader-state.js";
+
+/** Copy text to the clipboard, loading the native addon on first use. */
+export function copyToClipboard(text) {
+	return loadNative().copyToClipboard(text);
+}
+
+/** Read an image from the clipboard, loading the native addon on first use. */
+export function readImageFromClipboard() {
+	return loadNative().readImageFromClipboard();
+}

package/native/desktop.d.ts

@@ -0,0 +1,4 @@
+import type { DesktopSession, DesktopSessionOptions } from "./index.js";
+
+/** Construct a desktop session, loading the native addon on first use. */
+export declare function createDesktopSession(options: DesktopSessionOptions): DesktopSession;

package/native/desktop.js

@@ -0,0 +1,10 @@
+import { loadNative } from "./loader-state.js";
+
+/**
+ * Construct a desktop session without loading the native addon until the
+ * computer worker receives its initialization message.
+ */
+export function createDesktopSession(options) {
+	const { DesktopSession } = loadNative();
+	return new DesktopSession(options);
+}

package/native/embedded-addon.js

@@ -0,0 +1,31 @@
+
+// AUTOGENERATED FILE -- DO NOT EDIT DIRECTLY
+// See scripts/embed-native.ts
+
+/** @typedef {"modern" | "baseline" | "default"} EmbeddedAddonVariant */
+
+/**
+ * @typedef {Object} EmbeddedAddonFile
+ * @property {EmbeddedAddonVariant} variant
+ * @property {string} filename
+ * @property {number} size
+ * @property {string=} filePath
+ */
+
+/**
+ * @typedef {Object} EmbeddedAddonArchive
+ * @property {"tar.gz"} format
+ * @property {string} filename
+ * @property {string} filePath
+ */
+
+/**
+ * @typedef {Object} EmbeddedAddon
+ * @property {string} platformTag
+ * @property {string} version
+ * @property {EmbeddedAddonFile[]} files
+ * @property {EmbeddedAddonArchive=} archive
+ */
+
+/** @type {EmbeddedAddon|null} */
+export const embeddedAddon = null;