@fressh/react-native-terminal 0.1.0

package/nitrogen/generated/shared/c++/views/HybridTerminalComponent.hpp

@@ -0,0 +1,113 @@
+///
+/// HybridTerminalComponent.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#include <optional>
+#include <NitroModules/NitroDefines.hpp>
+#include <NitroModules/NitroHash.hpp>
+#include <NitroModules/CachedProp.hpp>
+#include <react/renderer/core/ConcreteComponentDescriptor.h>
+#include <react/renderer/core/PropsParserContext.h>
+#include <react/renderer/components/view/ConcreteViewShadowNode.h>
+#include <react/renderer/components/view/ViewProps.h>
+
+#include <string>
+#include <optional>
+#include <memory>
+#include "HybridTerminalSpec.hpp"
+#include <functional>
+
+namespace margelo::nitro::fressh::views {
+
+  using namespace facebook;
+
+  /**
+   * The name of the actual native View.
+   */
+  extern const char HybridTerminalComponentName[];
+
+  /**
+   * Props for the "Terminal" View.
+   */
+  class HybridTerminalProps final: public react::ViewProps {
+  public:
+    HybridTerminalProps() = default;
+    HybridTerminalProps(const react::PropsParserContext& context,
+                        const HybridTerminalProps& sourceProps,
+                        const react::RawProps& rawProps);
+
+  public:
+    CachedProp<std::string> fontPath;
+    CachedProp<std::optional<std::string>> configJson;
+    CachedProp<std::optional<std::string>> shellId;
+    CachedProp<std::optional<std::function<void(const std::shared_ptr<HybridTerminalSpec>& /* ref */)>>> hybridRef;
+
+  private:
+    static bool filterObjectKeys(const std::string& propName);
+  };
+
+  /**
+   * State for the "Terminal" View.
+   */
+  class HybridTerminalState final {
+  public:
+    HybridTerminalState() = default;
+    explicit HybridTerminalState(const std::shared_ptr<HybridTerminalProps>& props):
+      _props(props) {}
+
+  public:
+    [[nodiscard]]
+    const std::shared_ptr<HybridTerminalProps>& getProps() const {
+      return _props;
+    }
+
+  public:
+#ifdef ANDROID
+  HybridTerminalState(const HybridTerminalState& /* previousState */, folly::dynamic /* data */) {}
+  folly::dynamic getDynamic() const {
+    throw std::runtime_error("HybridTerminalState does not support folly!");
+  }
+  react::MapBuffer getMapBuffer() const {
+    throw std::runtime_error("HybridTerminalState does not support MapBuffer!");
+  };
+#endif
+
+  private:
+    std::shared_ptr<HybridTerminalProps> _props;
+  };
+
+  /**
+   * The Shadow Node for the "Terminal" View.
+   */
+  using HybridTerminalShadowNode = react::ConcreteViewShadowNode<HybridTerminalComponentName /* "HybridTerminal" */,
+                                                                 HybridTerminalProps /* custom props */,
+                                                                 react::ViewEventEmitter /* default */,
+                                                                 HybridTerminalState /* custom state */>;
+
+  /**
+   * The Component Descriptor for the "Terminal" View.
+   */
+  class HybridTerminalComponentDescriptor final: public react::ConcreteComponentDescriptor<HybridTerminalShadowNode> {
+  public:
+    explicit HybridTerminalComponentDescriptor(const react::ComponentDescriptorParameters& parameters);
+
+  public:
+    /**
+     * A faster path for cloning props - reuses the caching logic from `HybridTerminalProps`.
+     */
+    std::shared_ptr<const react::Props> cloneProps(const react::PropsParserContext& context,
+                                                   const std::shared_ptr<const react::Props>& props,
+                                                   react::RawProps rawProps) const override;
+#ifdef ANDROID
+    void adopt(react::ShadowNode& shadowNode) const override;
+#endif
+  };
+
+  /* The actual view for "Terminal" needs to be implemented in platform-specific code. */
+
+} // namespace margelo::nitro::fressh::views

package/nitrogen/generated/shared/json/TerminalConfig.json

@@ -0,0 +1,12 @@
+{
+  "uiViewClassName": "Terminal",
+  "supportsRawText": false,
+  "bubblingEventTypes": {},
+  "directEventTypes": {},
+  "validAttributes": {
+    "fontPath": true,
+    "configJson": true,
+    "shellId": true,
+    "hybridRef": true
+  }
+}

package/package.json

@@ -0,0 +1,97 @@
+{
+	"name": "@fressh/react-native-terminal",
+	"version": "0.1.0",
+	"description": "Native SSH terminal for React Native: russh + alacritty_terminal engine + native GLES renderer, in one package.",
+	"keywords": [
+		"alacritty",
+		"android",
+		"expo",
+		"ios",
+		"react-native",
+		"russh",
+		"rust",
+		"ssh",
+		"terminal"
+	],
+	"homepage": "https://github.com/EthanShoeDev/fressh#readme",
+	"bugs": {
+		"url": "https://github.com/EthanShoeDev/fressh/issues"
+	},
+	"license": "MIT",
+	"author": "EthanShoeDev <13422990+EthanShoeDev@users.noreply.github.com> (https://github.com/EthanShoeDev)",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/EthanShoeDev/fressh.git"
+	},
+	"source": "./src/index.ts",
+	"files": [
+		"android/build.gradle",
+		"android/CMakeLists.txt",
+		"android/fix-prefab.gradle",
+		"android/src",
+		"ios",
+		"cpp",
+		"nitro",
+		"nitrogen",
+		"src",
+		"*.podspec",
+		"*.xcframework/**",
+		"react-native.config.js",
+		"*.md",
+		"*.config.*",
+		"tsconfig*.json",
+		"LICENSE"
+	],
+	"type": "module",
+	"main": "./src/index.ts",
+	"types": "./src/index.ts",
+	"react-native": "./src/index.ts",
+	"exports": {
+		".": {
+			"types": "./src/index.ts",
+			"react-native": "./src/index.ts",
+			"default": "./src/index.ts"
+		},
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"tsgo:check": "tsgo --noEmit",
+		"nitro:codegen": "nitrogen",
+		"//native": "Single .so (§8): cargo-ndk builds the shim-uniffi staticlib (uniffi control plane + render C-ABI, sharing fressh-core's registry statics); the umbrella android/CMakeLists links it + the ubrn-generated C++ + the Nitro C++ into libReactNativeTerminal.so.",
+		"build:android": "cd rust && cargo ndk -t arm64-v8a -t x86_64 -o ../android/src/main/jniLibs build -p shim-uniffi --release",
+		"//build:ios": "iOS analogue of build:android (§1/§8): cargo-build shim-uniffi for device + sim, lipo the sim slices, package one shim_uniffi.xcframework the podspec links. JSI bindings (cpp/generated) come from the cross-platform ubrn:generate, so the xcframework needs no headers — just the staticlib.",
+		"build:ios": "cd rust && ./build-ios.sh",
+		"//angle:fetch": "Vendor prebuilt ANGLE (libEGL/libGLESv2, Metal) for iOS — the GLES2 driver the renderer runs over (§2/§5). Gitignored xcframeworks at the package root; run once (and after bumping the pinned tag).",
+		"angle:fetch": "./ios/fetch-angle.sh",
+		"//ubrn:generate": "Reads uniffi metadata from the HOST staticlib (.a) — the canonical ubrn library-mode input (ubrn itself uses .a for the android/ios targets). The .a name is OS-independent; the cdylib name is NOT (.so on Linux, .dylib on macOS), so hardcoding .so built fine on Linux but broke macOS. Do NOT change back to a platform-specific cdylib extension.",
+		"ubrn:generate": "cd rust && ubrn generate jsi bindings --library --ts-dir ../src/generated --cpp-dir ../cpp/generated target/debug/libshim_uniffi.a",
+		"//ubrn:build:ios": "ubrn build ios --and-generate --release",
+		"cargo:build": "cd rust && cargo build",
+		"cargo:lint:fix": "cd rust && just lint",
+		"cargo:lint:check": "cd rust && just lint-check",
+		"cargo:fmt:fix": "cd rust && just fmt",
+		"cargo:fmt:check": "cd rust && just fmt-check",
+		"cargo:test": "cd rust && just test",
+		"cargo:update": "cd rust && just update-deps"
+	},
+	"dependencies": {
+		"@ubjs/core": "0.31.0-3",
+		"uniffi-bindgen-react-native": "0.31.0-3"
+	},
+	"devDependencies": {
+		"@types/react": "catalog:",
+		"nitrogen": "0.35.9",
+		"react": "catalog:",
+		"react-native": "catalog:",
+		"react-native-nitro-modules": "0.35.9",
+		"typescript": "catalog:"
+	},
+	"peerDependencies": {
+		"react": ">=19.0.0",
+		"react-native": ">=0.85.0",
+		"react-native-nitro-modules": ">=0.35.0"
+	}
+}

package/react-native.config.js

@@ -0,0 +1,12 @@
+const path = require('node:path');
+
+module.exports = {
+	dependency: {
+		platforms: {
+			android: { sourceDir: 'android' },
+			// Autolink the hand-authored podspec (no xcodeproj — the pod compiles
+			// our ios/** + the generated bindings and links shim_uniffi.xcframework, §8).
+			ios: { podspecPath: path.join(__dirname, 'ReactNativeTerminal.podspec') },
+		},
+	},
+};

package/shim_uniffi.xcframework/Info.plist

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>AvailableLibraries</key>
+	<array>
+		<dict>
+			<key>BinaryPath</key>
+			<string>libshim_uniffi.a</string>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64</string>
+			<key>LibraryPath</key>
+			<string>libshim_uniffi.a</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+		</dict>
+		<dict>
+			<key>BinaryPath</key>
+			<string>libshim_uniffi.a</string>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64_x86_64-simulator</string>
+			<key>LibraryPath</key>
+			<string>libshim_uniffi.a</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+				<string>x86_64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
+		</dict>
+	</array>
+	<key>CFBundlePackageType</key>
+	<string>XFWK</string>
+	<key>XCFrameworkFormatVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>

package/src/Terminal.tsx

@@ -0,0 +1,135 @@
+import { type ComponentProps, type Ref, useMemo } from 'react';
+import { PixelRatio } from 'react-native';
+import { getHostComponent, type HybridRef } from 'react-native-nitro-modules';
+
+import TerminalViewConfig from '../nitrogen/generated/shared/json/TerminalConfig.json';
+import type { TerminalMethods, TerminalProps } from '../nitro/Terminal.nitro';
+
+/** Ref handle for imperative methods on the native terminal view. */
+export type TerminalRef = HybridRef<TerminalProps, TerminalMethods>;
+
+/** Cursor shapes the renderer can draw (config override; see fressh-render). */
+export type CursorStyle = 'block' | 'beam' | 'underline' | 'hollow';
+
+/** Cursor blink modes (see fressh-render `CursorBlink`). `never`/`always` force
+ * the behaviour; `off`/`on` defer to the program's escape sequences. */
+export type CursorBlink = 'never' | 'off' | 'on' | 'always';
+
+/**
+ * Friendly, logical-unit terminal config (the "assemble in RN, pass it" object).
+ * The wrapper scales sizes by device pixel density and serializes to the native
+ * `configJson` string prop. All fields optional — omitted ones use renderer
+ * defaults. `colorScheme` names must match the Rust presets (see `ColorScheme::
+ * by_name`): 'default' | 'solarizedDark' | 'solarizedLight' | 'dracula' |
+ * 'gruvboxDark'.
+ */
+export interface TerminalRenderConfig {
+	/** Font size in logical points. */
+	fontSize?: number;
+	/** Inner padding in logical points, applied to both axes. */
+	padding?: number;
+	cursorStyle?: CursorStyle;
+	/** Cursor blink mode (the live override). Default `off`. */
+	cursorBlink?: CursorBlink;
+	/** Blink half-period in ms. Default 750. */
+	blinkInterval?: number;
+	/** Stop blinking after this many seconds without input (cursor stays solid).
+	 * `0` disables the timeout (blink forever). Default 5. */
+	blinkTimeout?: number;
+	colorScheme?: string;
+	/** Draw bold text using the bright color variants. */
+	boldIsBright?: boolean;
+}
+
+/** Default font size (logical points) when `config.fontSize` is unset. */
+const DEFAULT_FONT_PT = 16;
+
+/** Serialize the friendly config to the native wire format (physical px). */
+function buildConfigJson(config: TerminalRenderConfig | undefined) {
+	const density = PixelRatio.get();
+	const fontPt =
+		config?.fontSize && config.fontSize > 0 ? config.fontSize : DEFAULT_FONT_PT;
+	const padPt = config?.padding ?? 0;
+	return JSON.stringify({
+		fontSizePx: fontPt * density,
+		paddingXPx: padPt * density,
+		paddingYPx: padPt * density,
+		cursorStyle: config?.cursorStyle ?? 'block',
+		cursorBlink: config?.cursorBlink ?? 'off',
+		blinkIntervalMs:
+			config?.blinkInterval && config.blinkInterval > 0
+				? config.blinkInterval
+				: 750,
+		// `?? 5` (not `||`) so an explicit 0 (no timeout) is preserved.
+		blinkTimeoutS: config?.blinkTimeout ?? 5,
+		colorScheme: config?.colorScheme ?? 'default',
+		boldIsBright: config?.boldIsBright ?? true,
+	});
+}
+
+const NativeTerminal = getHostComponent<TerminalProps, TerminalMethods>(
+	'Terminal',
+	() => TerminalViewConfig,
+);
+
+/** Props for the JS `<Terminal>` wrapper: the native component's props (incl. RN
+ * view props like `style`) minus the wire `configJson`, plus the friendly `config`
+ * object. */
+export type TerminalComponentProps = Omit<
+	ComponentProps<typeof NativeTerminal>,
+	'configJson'
+> & {
+	config?: TerminalRenderConfig;
+};
+
+/**
+ * Native terminal view (Nitro HybridView). Renders the durable `Term` that
+ * fressh-core keeps for `shellId`. Accepts standard RN view props (e.g. `style`)
+ * and a `config` object that is scaled + serialized to the renderer.
+ */
+export function Terminal({
+	config,
+	ref,
+	...props
+}: TerminalComponentProps & { ref?: Ref<TerminalRef> }) {
+	// Destructure the fields buildConfigJson reads so the memo depends on their
+	// values, not the (per-render) `config` object identity.
+	const {
+		fontSize,
+		padding,
+		cursorStyle,
+		cursorBlink,
+		blinkInterval,
+		blinkTimeout,
+		colorScheme,
+		boldIsBright,
+	} = config ?? {};
+	const configJson = useMemo(
+		() =>
+			buildConfigJson({
+				fontSize,
+				padding,
+				cursorStyle,
+				cursorBlink,
+				blinkInterval,
+				blinkTimeout,
+				colorScheme,
+				boldIsBright,
+			}),
+		[
+			fontSize,
+			padding,
+			cursorStyle,
+			cursorBlink,
+			blinkInterval,
+			blinkTimeout,
+			colorScheme,
+			boldIsBright,
+		],
+	);
+	// The runtime ref is the Nitro HybridRef (TerminalRef); the host-component's
+	// TS ref type is looser, so cast to keep the public contract.
+	return (
+		<NativeTerminal ref={ref as never} {...props} configJson={configJson} />
+	);
+}