react-native-nswindow 0.0.1

package/README.md

@@ -0,0 +1,150 @@
+# react-native-nswindow
+
+Multi-window support for React Native macOS. Create, modify, close, and observe native `NSWindow` instances from JavaScript.
+
+## Requirements
+
+- React Native macOS >= 0.81
+- macOS deployment target >= 14.0
+- New Architecture (TurboModules) enabled
+
+## Installation
+
+```bash
+npm install react-native-nswindow
+cd macos && pod install
+```
+
+## Usage
+
+```tsx
+import NSWindowModule from 'react-native-nswindow';
+import { AppRegistry } from 'react-native';
+
+// Register a component to render in the new window
+function MyWindow() {
+  return <Text>Hello from a new window!</Text>;
+}
+AppRegistry.registerComponent('MyWindow', () => MyWindow);
+
+// Create a window
+const windowId = await NSWindowModule.addWindow({
+  componentName: 'MyWindow',
+  windowName: 'my-window',
+  initialProps: {},
+  title: 'My Window',
+  width: 600,
+  height: 400,
+});
+
+// Modify it
+await NSWindowModule.modifyWindow(windowId, {
+  title: 'Updated Title',
+  backgroundColor: '#1e1e1e',
+  vibrancy: 'sidebar',
+});
+
+// Listen for events
+const sub = NSWindowModule.onWindowClose((id) => {
+  console.log('Window closed:', id);
+});
+sub.remove(); // cleanup
+```
+
+## API
+
+### Methods
+
+| Method | Description |
+|--------|-------------|
+| `addWindow(props: WindowProps)` | Create a new window. Returns its ID. |
+| `closeWindow(windowId)` | Close a window. |
+| `modifyWindow(windowId, props)` | Modify window properties. |
+| `listWindows()` | List all tracked window IDs. |
+| `getWindowState(windowId)` | Get position, size, and state flags. |
+| `focusWindow(windowId)` | Make window key and bring to front. |
+| `hideWindow(windowId)` | Hide (order out) a window. |
+| `showWindow(windowId)` | Show (order front) a window. |
+| `minimizeWindow(windowId)` | Minimize to dock. |
+| `deminimizeWindow(windowId)` | Restore from dock. |
+| `setFullScreen(windowId, bool)` | Enter/exit full screen. |
+| `bringToFront(windowId)` | Order front. |
+| `sendToBack(windowId)` | Order back. |
+| `getScreenInfo()` | Get screen layout info (all screens, total bounds, main screen). |
+
+### Window Props
+
+All properties are optional except `componentName`, `windowName`, and `initialProps` (on `addWindow`).
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `x`, `y` | number | 100 | Window origin |
+| `width`, `height` | number | 400×300 | Window size |
+| `minWidth`, `minHeight` | number | — | Minimum size constraints |
+| `maxWidth`, `maxHeight` | number | — | Maximum size constraints |
+| `center` | boolean | false | Center on screen |
+| `title` | string | windowName | Title bar text |
+| `titleBarStyle` | string | 'default' | 'default' \| 'hidden' \| 'hiddenInset' \| 'transparent' |
+| `vibrancy` | string | 'none' | 'none' \| 'sidebar' \| 'menu' \| 'popover' \| 'fullScreenUI' \| 'underWindowBackground' \| 'hudWindow' |
+| `backgroundColor` | string | — | Any React Native color string (e.g. '#ff0000', 'rgba(0,0,0,0.5)', 'red') |
+| `transparent` | boolean | false | Set window non-opaque (required for translucent backgrounds) |
+| `hasShadow` | boolean | true | Window shadow |
+| `resizable` | boolean | true | Allow resize |
+| `movable` | boolean | true | Allow drag |
+| `minimizable` | boolean | true | Show minimize button |
+| `closable` | boolean | true | Show close button |
+| `zoomable` | boolean | true | Enable zoom button |
+| `alwaysOnTop` | boolean | false | Float above other windows |
+| `level` | string | 'normal' | 'normal' \| 'floating' \| 'modalPanel' \| 'mainMenu' \| 'statusBar' \| 'screenSaver' |
+| `show` | boolean | true | Show immediately |
+| `focusOnCreate` | boolean | true | Make key on show |
+| `autoSaveFrame` | string | — | Persist frame position across launches |
+| `stopShouldClose` | boolean | false | Intercept close (window stays open) |
+
+### Events
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `onWindowClose` | windowId | Window was closed |
+| `onWindowWillClose` | windowId | Close was attempted (fires even if blocked) |
+| `onWindowFocus` | windowId | Became key window |
+| `onWindowBlur` | windowId | Resigned key window |
+| `onWindowMove` | `{ windowId, x, y }` | Window moved |
+| `onWindowResize` | `{ windowId, width, height }` | Window resized |
+| `onWindowMinimize` | windowId | Minimized to dock |
+| `onWindowDeminimize` | windowId | Restored from dock |
+| `onWindowEnterFullScreen` | windowId | Entered full screen |
+| `onWindowExitFullScreen` | windowId | Exited full screen |
+| `onWindowOcclusionStateChange` | `{ windowId, isVisible }` | Window occlusion state changed (visible/occluded) |
+| `onWindowBackingPropertiesChange` | windowId | Backing properties changed (e.g. moved between Retina/non-Retina displays) |
+| `onScreenInfoChange` | — | Screen parameters changed (display added/removed/resized) |
+
+Events use the New Architecture `EventEmitter` pattern. Each event method takes a callback and returns a subscription with a `.remove()` method:
+
+```tsx
+import { useEffect } from 'react';
+import NSWindowModule from 'react-native-nswindow';
+
+useEffect(() => {
+  const subs = [
+    NSWindowModule.onWindowClose((windowId) => {
+      console.log('closed:', windowId);
+    }),
+    NSWindowModule.onWindowMove(({ windowId, x, y }) => {
+      console.log('moved:', windowId, x, y);
+    }),
+    NSWindowModule.onWindowResize(({ windowId, width, height }) => {
+      console.log('resized:', windowId, width, height);
+    }),
+  ];
+  return () => subs.forEach((s) => s.remove());
+}, []);
+```
+
+## How It Works
+
+This is a C++ TurboModule (CxxTurboModule). An ObjC singleton (`RNNSWindowHelper`) manages the window dictionary, acts as `NSWindowDelegate`, and observes `NSNotificationCenter` for all window events. Window operations dispatch to the main thread; promises resolve via the JS invoker.
+
+## License
+
+MIT

package/macos/RNNSWindow.h

@@ -0,0 +1,142 @@
+#pragma once
+
+#include "RNNSWindowSpecJSI.h"
+#include <ReactCommon/TurboModuleUtils.h>
+
+namespace facebook::react {
+
+// Concrete types from codegen structs
+using WindowProps = NativeNSWindowWindowProps<
+    std::optional<double>, std::optional<double>, std::optional<double>,
+    std::optional<double>, std::optional<double>, std::optional<double>,
+    std::optional<double>, std::optional<double>, std::optional<bool>,
+    std::optional<std::string>, std::optional<std::string>,
+    std::optional<std::string>, std::optional<std::string>, std::optional<bool>,
+    std::optional<bool>, std::optional<bool>, std::optional<bool>,
+    std::optional<bool>, std::optional<bool>, std::optional<bool>,
+    std::optional<bool>, std::optional<std::string>, std::optional<bool>,
+    std::optional<bool>, std::optional<std::string>, std::optional<bool>,
+    std::string, std::string, jsi::Object>;
+
+using ModifyProps = NativeNSWindowModifyableWindowProps<
+    std::optional<double>, std::optional<double>, std::optional<double>,
+    std::optional<double>, std::optional<double>, std::optional<double>,
+    std::optional<double>, std::optional<double>, std::optional<bool>,
+    std::optional<std::string>, std::optional<std::string>,
+    std::optional<std::string>, std::optional<std::string>, std::optional<bool>,
+    std::optional<bool>, std::optional<bool>, std::optional<bool>,
+    std::optional<bool>, std::optional<bool>, std::optional<bool>,
+    std::optional<bool>, std::optional<std::string>, std::optional<bool>,
+    std::optional<bool>, std::optional<std::string>, std::optional<bool>>;
+
+// Concrete types for events
+using WindowMovePayload =
+    NativeNSWindowWindowMovePayload<std::string, double, double>;
+using WindowResizePayload =
+    NativeNSWindowWindowResizePayload<std::string, double, double>;
+using WindowOcclusionStatePayload =
+    NativeNSWindowWindowOcclusionStatePayload<std::string, bool>;
+using WindowRect = NativeNSWindowRect<double, double, double, double>;
+using WindowStateResult =
+    NativeNSWindowWindowState<std::string, std::string, double, double, double,
+                              double, bool, bool, bool, bool, bool, double,
+                              std::optional<WindowRect>>;
+
+} // namespace facebook::react
+
+// bridging support for event payload structs
+namespace facebook::react {
+
+template <> struct Bridging<WindowMovePayload> {
+  static WindowMovePayload
+  fromJs(jsi::Runtime &rt, const jsi::Object &value,
+         const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowMovePayloadBridging<WindowMovePayload>::fromJs(
+        rt, value, jsInvoker);
+  }
+
+  static jsi::Object toJs(jsi::Runtime &rt, const WindowMovePayload &value,
+                          const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowMovePayloadBridging<WindowMovePayload>::toJs(
+        rt, value, jsInvoker);
+  }
+};
+
+template <> struct Bridging<WindowResizePayload> {
+  static WindowResizePayload
+  fromJs(jsi::Runtime &rt, const jsi::Object &value,
+         const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowResizePayloadBridging<
+        WindowResizePayload>::fromJs(rt, value, jsInvoker);
+  }
+
+  static jsi::Object toJs(jsi::Runtime &rt, const WindowResizePayload &value,
+                          const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowResizePayloadBridging<WindowResizePayload>::toJs(
+        rt, value, jsInvoker);
+  }
+};
+
+template <> struct Bridging<WindowOcclusionStatePayload> {
+  static WindowOcclusionStatePayload
+  fromJs(jsi::Runtime &rt, const jsi::Object &value,
+         const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowOcclusionStatePayloadBridging<
+        WindowOcclusionStatePayload>::fromJs(rt, value, jsInvoker);
+  }
+
+  static jsi::Object toJs(jsi::Runtime &rt,
+                          const WindowOcclusionStatePayload &value,
+                          const std::shared_ptr<CallInvoker> &jsInvoker) {
+    return NativeNSWindowWindowOcclusionStatePayloadBridging<
+        WindowOcclusionStatePayload>::toJs(rt, value, jsInvoker);
+  }
+};
+
+} // namespace facebook::react
+
+namespace facebook::react {
+
+class RNNSWindow : public NativeNSWindowCxxSpec<RNNSWindow> {
+public:
+  RNNSWindow(std::shared_ptr<CallInvoker> jsInvoker);
+  ~RNNSWindow();
+
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowClose;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowWillClose;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowMove;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowResize;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowFocus;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowBlur;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowMinimize;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowDeminimize;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowEnterFullScreen;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowExitFullScreen;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowOcclusionStateChange;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnWindowBackingPropertiesChange;
+  using NativeNSWindowCxxSpec<RNNSWindow>::emitOnScreenInfoChange;
+
+  jsi::Value addWindow(jsi::Runtime &rt, jsi::Object props);
+  jsi::Value closeWindow(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value modifyWindow(jsi::Runtime &rt, jsi::String windowId,
+                          jsi::Object props);
+
+  jsi::Value listWindows(jsi::Runtime &rt);
+  jsi::Value getWindowState(jsi::Runtime &rt, jsi::String windowId);
+
+  jsi::Value focusWindow(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value hideWindow(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value showWindow(jsi::Runtime &rt, jsi::String windowId);
+
+  jsi::Value minimizeWindow(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value deminimizeWindow(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value setFullScreen(jsi::Runtime &rt, jsi::String windowId,
+                           bool fullscreen);
+
+  jsi::Value bringToFront(jsi::Runtime &rt, jsi::String windowId);
+  jsi::Value sendToBack(jsi::Runtime &rt, jsi::String windowId);
+
+  jsi::Value getScreenInfo(jsi::Runtime &rt);
+};
+
+} // namespace facebook::react