@salve-software/react-native-nitro-jsdom 1.0.0

package/nitrogen/generated/android/kotlin/com/margelo/nitro/nitrojsdom/NitroJsdomOnLoad.kt

@@ -0,0 +1,35 @@
+///
+/// NitroJsdomOnLoad.kt
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+package com.margelo.nitro.nitrojsdom
+
+import android.util.Log
+
+internal class NitroJsdomOnLoad {
+  companion object {
+    private const val TAG = "NitroJsdomOnLoad"
+    private var didLoad = false
+    /**
+     * Initializes the native part of "NitroJsdom".
+     * This method is idempotent and can be called more than once.
+     */
+    @JvmStatic
+    fun initializeNative() {
+      if (didLoad) return
+      try {
+        Log.i(TAG, "Loading NitroJsdom C++ library...")
+        System.loadLibrary("NitroJsdom")
+        Log.i(TAG, "Successfully loaded NitroJsdom C++ library!")
+        didLoad = true
+      } catch (e: Error) {
+        Log.e(TAG, "Failed to load NitroJsdom C++ library! Is it properly installed and linked? " +
+                    "Is the name correct? (see `CMakeLists.txt`, at `add_library(...)`)", e)
+        throw e
+      }
+    }
+  }
+}

package/nitrogen/generated/ios/NitroJsdom+autolinking.rb

@@ -0,0 +1,62 @@
+#
+# NitroJsdom+autolinking.rb
+# This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+# https://github.com/mrousavy/nitro
+# Copyright © Marc Rousavy @ Margelo
+#
+
+# This is a Ruby script that adds all files generated by Nitrogen
+# to the given podspec.
+#
+# To use it, add this to your .podspec:
+# ```ruby
+# Pod::Spec.new do |spec|
+#   # ...
+#
+#   # Add all files generated by Nitrogen
+#   load 'nitrogen/generated/ios/NitroJsdom+autolinking.rb'
+#   add_nitrogen_files(spec)
+# end
+# ```
+
+def add_nitrogen_files(spec)
+  Pod::UI.puts "[NitroModules] 🔥 NitroJsdom is boosted by nitro!"
+
+  spec.dependency "NitroModules"
+
+  current_source_files = Array(spec.attributes_hash['source_files'])
+  spec.source_files = current_source_files + [
+    # Generated cross-platform specs
+    "nitrogen/generated/shared/**/*.{h,hpp,c,cpp,swift}",
+    # Generated bridges for the cross-platform specs
+    "nitrogen/generated/ios/**/*.{h,hpp,c,cpp,mm,swift}",
+  ]
+
+  current_public_header_files = Array(spec.attributes_hash['public_header_files'])
+  spec.public_header_files = current_public_header_files + [
+    # Generated specs
+    "nitrogen/generated/shared/**/*.{h,hpp}",
+    # Swift to C++ bridging helpers
+    "nitrogen/generated/ios/NitroJsdom-Swift-Cxx-Bridge.hpp"
+  ]
+
+  current_private_header_files = Array(spec.attributes_hash['private_header_files'])
+  spec.private_header_files = current_private_header_files + [
+    # iOS specific specs
+    "nitrogen/generated/ios/c++/**/*.{h,hpp}",
+    # Views are framework-specific and should be private
+    "nitrogen/generated/shared/**/views/**/*"
+  ]
+
+  current_pod_target_xcconfig = spec.attributes_hash['pod_target_xcconfig'] || {}
+  spec.pod_target_xcconfig = current_pod_target_xcconfig.merge({
+    # Use C++ 20
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
+    # Enables C++ <-> Swift interop (by default it's only ObjC)
+    "SWIFT_OBJC_INTEROP_MODE" => "objcxx",
+    # Enables stricter modular headers
+    "DEFINES_MODULE" => "YES",
+    # Disable auto-generated ObjC header for Swift (Static linkage on Xcode 26.4 breaks here)
+    "SWIFT_INSTALL_OBJC_HEADER" => "NO",
+  })
+end

package/nitrogen/generated/ios/NitroJsdom-Swift-Cxx-Bridge.cpp

@@ -0,0 +1,17 @@
+///
+/// NitroJsdom-Swift-Cxx-Bridge.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "NitroJsdom-Swift-Cxx-Bridge.hpp"
+
+// Include C++ implementation defined types
+
+
+namespace margelo::nitro::nitrojsdom::bridge::swift {
+
+  
+
+} // namespace margelo::nitro::nitrojsdom::bridge::swift

package/nitrogen/generated/ios/NitroJsdom-Swift-Cxx-Bridge.hpp

@@ -0,0 +1,27 @@
+///
+/// NitroJsdom-Swift-Cxx-Bridge.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+// Forward declarations of C++ defined types
+
+
+// Forward declarations of Swift defined types
+
+
+// Include C++ defined types
+
+
+/**
+ * Contains specialized versions of C++ templated types so they can be accessed from Swift,
+ * as well as helper functions to interact with those C++ types from Swift.
+ */
+namespace margelo::nitro::nitrojsdom::bridge::swift {
+
+  
+
+} // namespace margelo::nitro::nitrojsdom::bridge::swift

package/nitrogen/generated/ios/NitroJsdom-Swift-Cxx-Umbrella.hpp

@@ -0,0 +1,38 @@
+///
+/// NitroJsdom-Swift-Cxx-Umbrella.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+// Forward declarations of C++ defined types
+
+
+// Include C++ defined types
+
+
+// C++ helpers for Swift
+#include "NitroJsdom-Swift-Cxx-Bridge.hpp"
+
+// Common C++ types used in Swift
+#include <NitroModules/ArrayBufferHolder.hpp>
+#include <NitroModules/AnyMapUtils.hpp>
+#include <NitroModules/RuntimeError.hpp>
+#include <NitroModules/DateToChronoDate.hpp>
+
+// Forward declarations of Swift defined types
+
+
+// Include Swift defined types
+#if __has_include("NitroJsdom-Swift.h")
+// This header is generated by Xcode/Swift on every app build.
+// If it cannot be found, make sure the Swift module's name (= podspec name) is actually "NitroJsdom".
+#include "NitroJsdom-Swift.h"
+// Same as above, but used when building with frameworks (`use_frameworks`)
+#elif __has_include(<NitroJsdom/NitroJsdom-Swift.h>)
+#include <NitroJsdom/NitroJsdom-Swift.h>
+#else
+#error NitroJsdom's autogenerated Swift header cannot be found! Make sure the Swift module's name (= podspec name) is actually "NitroJsdom", and try building the app first.
+#endif

package/nitrogen/generated/ios/NitroJsdomAutolinking.mm

@@ -0,0 +1,35 @@
+///
+/// NitroJsdomAutolinking.mm
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#import <Foundation/Foundation.h>
+#import <NitroModules/HybridObjectRegistry.hpp>
+
+#import <type_traits>
+
+#include "HybridHtmlSandbox.hpp"
+
+@interface NitroJsdomAutolinking : NSObject
+@end
+
+@implementation NitroJsdomAutolinking
+
++ (void) load {
+  using namespace margelo::nitro;
+  using namespace margelo::nitro::nitrojsdom;
+
+  HybridObjectRegistry::registerHybridObjectConstructor(
+    "HtmlSandbox",
+    []() -> std::shared_ptr<HybridObject> {
+      static_assert(std::is_default_constructible_v<HybridHtmlSandbox>,
+                    "The HybridObject \"HybridHtmlSandbox\" is not default-constructible! "
+                    "Create a public constructor that takes zero arguments to be able to autolink this HybridObject.");
+      return std::make_shared<HybridHtmlSandbox>();
+    }
+  );
+}
+
+@end

package/nitrogen/generated/ios/NitroJsdomAutolinking.swift

@@ -0,0 +1,16 @@
+///
+/// NitroJsdomAutolinking.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+// TODO: Use empty enums once Swift supports exporting them as namespaces
+//       See: https://github.com/swiftlang/swift/pull/83616
+public final class NitroJsdomAutolinking {
+  public typealias bridge = margelo.nitro.nitrojsdom.bridge.swift
+
+  
+}

package/nitrogen/generated/shared/c++/HybridHtmlSandboxSpec.cpp

@@ -0,0 +1,26 @@
+///
+/// HybridHtmlSandboxSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridHtmlSandboxSpec.hpp"
+
+namespace margelo::nitro::nitrojsdom {
+
+  void HybridHtmlSandboxSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("initialize", &HybridHtmlSandboxSpec::initialize);
+      prototype.registerHybridMethod("evaluate", &HybridHtmlSandboxSpec::evaluate);
+      prototype.registerHybridMethod("serialize", &HybridHtmlSandboxSpec::serialize);
+      prototype.registerHybridMethod("setConsoleCallback", &HybridHtmlSandboxSpec::setConsoleCallback);
+      prototype.registerHybridMethod("setDialogCallbacks", &HybridHtmlSandboxSpec::setDialogCallbacks);
+      prototype.registerHybridMethod("setFetchCallback", &HybridHtmlSandboxSpec::setFetchCallback);
+    });
+  }
+
+} // namespace margelo::nitro::nitrojsdom

package/nitrogen/generated/shared/c++/HybridHtmlSandboxSpec.hpp

@@ -0,0 +1,73 @@
+///
+/// HybridHtmlSandboxSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <string>
+#include <NitroModules/Promise.hpp>
+#include <NitroModules/Null.hpp>
+#include <vector>
+#include <functional>
+#include <variant>
+#include <optional>
+
+namespace margelo::nitro::nitrojsdom {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `HtmlSandbox`
+   * Inherit this class to create instances of `HybridHtmlSandboxSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridHtmlSandbox: public HybridHtmlSandboxSpec {
+   * public:
+   *   HybridHtmlSandbox(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridHtmlSandboxSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridHtmlSandboxSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridHtmlSandboxSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual void initialize(const std::string& html, bool runScripts, const std::string& url) = 0;
+      virtual std::shared_ptr<Promise<std::string>> evaluate(const std::string& script) = 0;
+      virtual std::string serialize() = 0;
+      virtual void setConsoleCallback(const std::optional<std::variant<nitro::NullType, std::function<void(const std::string& /* level */, const std::vector<std::string>& /* args */)>>>& callback) = 0;
+      virtual void setDialogCallbacks(const std::optional<std::variant<nitro::NullType, std::function<void(const std::string& /* message */)>>>& onAlert, const std::optional<std::variant<nitro::NullType, std::function<std::shared_ptr<Promise<bool>>(const std::string& /* message */)>>>& onConfirm, const std::optional<std::variant<nitro::NullType, std::function<std::shared_ptr<Promise<std::variant<nitro::NullType, std::string>>>(const std::string& /* message */, const std::optional<std::string>& /* defaultValue */)>>>& onPrompt) = 0;
+      virtual void setFetchCallback(const std::optional<std::variant<nitro::NullType, std::function<std::shared_ptr<Promise<std::shared_ptr<Promise<std::string>>>>(const std::string& /* url */, const std::string& /* method */, const std::string& /* headersJson */, const std::optional<std::string>& /* body */)>>>& callback) = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "HtmlSandbox";
+  };
+
+} // namespace margelo::nitro::nitrojsdom

package/package.json

@@ -0,0 +1,131 @@
+{
+  "name": "@salve-software/react-native-nitro-jsdom",
+  "version": "1.0.0",
+  "packageManager": "yarn@4.9.1",
+  "description": "A headless HTML/DOM environment for React Native.",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "scripts": {
+    "postinstall": "bash scripts/setup-clangd.sh",
+    "ai:setup": "aiworkers setup",
+    "typecheck": "tsc --noEmit",
+    "clean": "git clean -dfX",
+    "release": "semantic-release",
+    "build": "yarn run typecheck && bob build",
+    "codegen": "nitrogen --logLevel=\"debug\" && yarn run build",
+    "postcodegen": "yarn --cwd example pod",
+    "example": "yarn workspace @salve-software/react-native-nitro-jsdom-example",
+    "docs": "yarn --cwd website build && yarn --cwd website serve",
+    "docs:dev": "yarn --cwd website start",
+    "docs:build": "yarn --cwd website build"
+  },
+  "keywords": [
+    "react-native",
+    "@salve-software/react-native-nitro-jsdom"
+  ],
+  "files": [
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
+    "cpp",
+    "nitro.json",
+    "android/build.gradle",
+    "android/fix-prefab.gradle",
+    "android/gradle.properties",
+    "android/CMakeLists.txt",
+    "android/src",
+    "ios/**/*.h",
+    "ios/**/*.m",
+    "ios/**/*.mm",
+    "ios/**/*.cpp",
+    "ios/**/*.swift",
+    "app.plugin.js",
+    "*.podspec",
+    "README.md"
+  ],
+  "workspaces": [
+    "example"
+  ],
+  "repository": "https://github.com/Salve-Software/react-native-nitro-jsdom.git",
+  "author": "eumaninho54",
+  "license": "MIT",
+  "bugs": "https://github.com/Salve-Software/react-native-nitro-jsdom/issues",
+  "homepage": "https://github.com/Salve-Software/react-native-nitro-jsdom#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@jamesacarr/eslint-formatter-github-actions": "^0.2.0",
+    "@salve-software/aiworkers": "^0.3.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/jest": "^29.5.12",
+    "@types/react": "19.2.0",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
+    "nitrogen": "0.35.6",
+    "react": "19.2.3",
+    "react-native": "0.84.1",
+    "react-native-builder-bob": "^0.40.18",
+    "react-native-nitro-modules": "0.35.6",
+    "semantic-release": "^25.0.3",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "*"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "warn",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false,
+    "semi": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.json"
+        }
+      ]
+    ]
+  }
+}

package/src/classes/JSDOM/JSDOM.class.ts

@@ -0,0 +1,145 @@
+import type { HtmlSandbox } from "../../specs/HtmlSandbox.nitro";
+import type { IJSDOMOptions } from "./types";
+import { NitroModules } from "react-native-nitro-modules";
+
+function safeParseHeaders(headersJson: string): Record<string, string> {
+  try {
+    const parsed = JSON.parse(headersJson);
+    return parsed && typeof parsed === 'object' ? parsed : {};
+  } catch {
+    return {};
+  }
+}
+
+export class JSDOM {
+  private sandbox: HtmlSandbox | null;
+  private _disposed: boolean = false;
+
+  private constructor(sandbox: HtmlSandbox) {
+    this.sandbox = sandbox;
+  }
+
+  /**
+   * Creates a new sandboxed DOM environment.
+   *
+   * @param html - The initial HTML document string.
+   * @param options.runScripts - Execute `<script>` tags found in the HTML. Default: `true`.
+   * @param options.url - Value of `window.location.href` inside the sandbox. Default: `'about:blank'`.
+   * @param options.pretendToBeVisual - Sets `document.hidden = false`, allowing scripts that
+   *   gate on page visibility (e.g. `requestAnimationFrame`) to run. Default: `false`.
+   *
+   * @example
+   * ```ts
+   * const dom = JSDOM.create('<html><body><div id="result">0</div></body></html>')
+   * await dom.evaluate(`document.getElementById('result').textContent = String(2 + 2)`)
+   * const value = await dom.evaluate(`document.getElementById('result').textContent`)
+   * // value → "4"
+   * dom.dispose()
+   * ```
+   */
+  static create(html: string, options?: IJSDOMOptions): JSDOM {
+    const sandbox = NitroModules.createHybridObject<HtmlSandbox>('HtmlSandbox');
+
+    sandbox.initialize(
+      html,
+      options?.runScripts ?? true,
+      options?.url ?? 'about:blank',
+    );
+
+    if (options?.onConsole) {
+      const cb = options.onConsole;
+      sandbox.setConsoleCallback((level, args) => cb(level as any, args));
+    } else {
+      sandbox.setConsoleCallback(null);
+    }
+
+    if (options?.onAlert || options?.onConfirm || options?.onPrompt) {
+      sandbox.setDialogCallbacks(
+        options.onAlert ?? null,
+        options.onConfirm ?? null,
+        options.onPrompt ?? null,
+      );
+    }
+
+    if (options?.onFetch) {
+      const onFetch = options.onFetch;
+      sandbox.setFetchCallback(async (url, method, headersJson, body) => {
+        const headers = safeParseHeaders(headersJson);
+        return onFetch(url, { method, headers, body })
+          .then((res) => JSON.stringify({
+            ok: (res.status ?? 200) >= 200 && (res.status ?? 200) < 300,
+            status: res.status ?? 200,
+            statusText: res.statusText ?? '',
+            headersJson: JSON.stringify(res.headers ?? {}),
+            body: res.body ?? '',
+          }))
+          .catch((err) => JSON.stringify({ error: err instanceof Error ? err.message : String(err) }));
+      });
+    }
+
+    return new JSDOM(sandbox);
+  }
+
+  /**
+   * Runs arbitrary JavaScript inside the isolated QuickJS sandbox.
+   * The return value is coerced to a string (same behaviour as `String(expr)` in JS).
+   *
+   * This is the **only** door into the sandbox — all DOM queries and mutations must
+   * be expressed as JS strings passed to `evaluate()`.
+   *
+   * @param script - Any valid JS expression or block of statements.
+   * @returns The stringified result of the last evaluated expression.
+   *
+   * @example
+   * ```ts
+   * // Mutate the DOM
+   * await dom.evaluate(`document.getElementById('price').textContent = (qty * unitPrice).toFixed(2)`)
+   *
+   * // Read from the DOM
+   * const text = await dom.evaluate(`document.getElementById('price').textContent`)
+   * // text → "42.00"
+   * ```
+   */
+  evaluate(script: string): Promise<string> {
+    if (this._disposed) {
+      return Promise.reject(new Error("JSDOM instance has been disposed"));
+    }
+    return this.sandbox!.evaluate(script);
+  }
+
+  /**
+   * Serializes the current state of the document back to an HTML string.
+   * Reflects any DOM mutations made via `evaluate()`.
+   *
+   * Returns an empty string if called after `dispose()`.
+   *
+   * @example
+   * ```ts
+   * await dom.evaluate(`document.title = 'Hello'`)
+   * dom.serialize() // "<html><head><title>Hello</title></head>...</html>"
+   * ```
+   */
+  serialize(): string {
+    if (this._disposed) return "";
+    return this.sandbox!.serialize();
+  }
+
+  /**
+   * Frees all native memory held by this sandbox (Lexbor document + QuickJS runtime).
+   * After calling `dispose()`, any further `evaluate()` calls will reject with an error.
+   * Calling `dispose()` multiple times is safe (idempotent).
+   * Always call this when you are done with the sandbox to avoid memory leaks.
+   *
+   * @example
+   * ```ts
+   * const dom = JSDOM.create(html)
+   * const value = await dom.evaluate(`window.__result`)
+   * dom.dispose() // ← always pair with create()
+   * ```
+   */
+  dispose(): void {
+    if (this._disposed) return;
+    this._disposed = true;
+    this.sandbox = null;
+  }
+}

package/src/classes/JSDOM/index.ts

@@ -0,0 +1,2 @@
+export type * from './types';
+export * from './JSDOM.class';

package/src/classes/JSDOM/types/IFetchOptions.ts

@@ -0,0 +1,14 @@
+/** The request passed to `onFetch` when `fetch(url, init)` is called inside the sandbox. */
+export interface IFetchRequestInit {
+  method: string;
+  headers: Record<string, string>;
+  body?: string;
+}
+
+/** The response `onFetch` must resolve with. */
+export interface IFetchResponseInit {
+  status: number;
+  statusText?: string;
+  headers?: Record<string, string>;
+  body?: string;
+}