react-native-fast-json 0.1.0

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

@@ -0,0 +1,34 @@
+///
+/// HybridJsonViewSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridJsonViewSpec.hpp"
+
+namespace margelo::nitro::fastjson {
+
+  void HybridJsonViewSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("type", &HybridJsonViewSpec::getType);
+      prototype.registerHybridSetter("type", &HybridJsonViewSpec::setType);
+      prototype.registerHybridGetter("length", &HybridJsonViewSpec::getLength);
+      prototype.registerHybridSetter("length", &HybridJsonViewSpec::setLength);
+      prototype.registerHybridMethod("rawJson", &HybridJsonViewSpec::rawJson);
+      prototype.registerHybridMethod("getValue", &HybridJsonViewSpec::getValue);
+      prototype.registerHybridMethod("keys", &HybridJsonViewSpec::keys);
+      prototype.registerHybridMethod("at", &HybridJsonViewSpec::at);
+      prototype.registerHybridMethod("atPath", &HybridJsonViewSpec::atPath);
+      prototype.registerHybridMethod("atPathWithWildcard", &HybridJsonViewSpec::atPathWithWildcard);
+      prototype.registerHybridMethod("asString", &HybridJsonViewSpec::asString);
+      prototype.registerHybridMethod("asNumber", &HybridJsonViewSpec::asNumber);
+      prototype.registerHybridMethod("asBoolean", &HybridJsonViewSpec::asBoolean);
+      prototype.registerHybridMethod("asObject", &HybridJsonViewSpec::asObject);
+    });
+  }
+
+} // namespace margelo::nitro::fastjson

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

@@ -0,0 +1,81 @@
+///
+/// HybridJsonViewSpec.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
+
+// Forward declaration of `HybridJsonViewSpec` to properly resolve imports.
+namespace margelo::nitro::fastjson { class HybridJsonViewSpec; }
+
+#include <string>
+#include <NitroModules/Null.hpp>
+#include <memory>
+#include "HybridJsonViewSpec.hpp"
+#include <variant>
+#include <vector>
+#include <NitroModules/AnyMap.hpp>
+
+namespace margelo::nitro::fastjson {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `JsonView`
+   * Inherit this class to create instances of `HybridJsonViewSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridJsonView: public HybridJsonViewSpec {
+   * public:
+   *   HybridJsonView(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridJsonViewSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridJsonViewSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridJsonViewSpec() override = default;
+
+    public:
+      // Properties
+      virtual std::string getType() = 0;
+      virtual void setType(const std::string& type) = 0;
+      virtual double getLength() = 0;
+      virtual void setLength(double length) = 0;
+
+    public:
+      // Methods
+      virtual std::string rawJson() = 0;
+      virtual std::variant<nitro::NullType, std::shared_ptr<HybridJsonViewSpec>> getValue(const std::string& key) = 0;
+      virtual std::vector<std::string> keys() = 0;
+      virtual std::variant<nitro::NullType, std::shared_ptr<HybridJsonViewSpec>> at(double index) = 0;
+      virtual std::variant<nitro::NullType, std::shared_ptr<HybridJsonViewSpec>> atPath(const std::string& path) = 0;
+      virtual std::variant<nitro::NullType, std::vector<std::string>> atPathWithWildcard(const std::string& path) = 0;
+      virtual std::string asString() = 0;
+      virtual double asNumber() = 0;
+      virtual bool asBoolean() = 0;
+      virtual std::shared_ptr<AnyMap> asObject() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "JsonView";
+  };
+
+} // namespace margelo::nitro::fastjson

package/package.json

@@ -0,0 +1,185 @@
+{
+  "name": "react-native-fast-json",
+  "version": "0.1.0",
+  "description": "Fast JSON parsing for large files in React Native, powered by simdjson (C++ SIMD acceleration) via Nitro Modules",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-fast-json-example",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "nitrogen": "nitrogen",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "release-it --only-version"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "json",
+    "json-parser",
+    "json-parse",
+    "simdjson",
+    "simd",
+    "large-json",
+    "fast-json",
+    "nitro",
+    "cpp"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ifeoluwak/react-native-fast-json.git"
+  },
+  "author": "ifeoluwa <ifeoluwaking24@gmail.com> (https://github.com/ifeoluwak)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ifeoluwak/react-native-fast-json/issues"
+  },
+  "homepage": "https://github.com/ifeoluwak/react-native-fast-json#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^20.5.0",
+    "@eslint/compat": "^2.0.3",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^10.0.1",
+    "@jest/globals": "^30.0.0",
+    "@react-native/babel-preset": "0.85.0",
+    "@react-native/eslint-config": "0.85.0",
+    "@react-native/jest-preset": "0.85.0",
+    "@release-it/conventional-changelog": "^10.0.6",
+    "@types/react": "^19.2.0",
+    "commitlint": "^20.5.0",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-ft-flow": "^3.0.11",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^30.3.0",
+    "lefthook": "^2.1.4",
+    "nitrogen": "^0.35.5",
+    "prettier": "^3.8.1",
+    "react": "19.2.3",
+    "react-native": "0.85.0",
+    "react-native-builder-bob": "^0.41.0",
+    "react-native-nitro-modules": "^0.35.5",
+    "release-it": "^19.2.4",
+    "turbo": "^2.8.21",
+    "typescript": "^6.0.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "^0.35.5"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "@react-native/jest-preset",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "nitro-module",
+    "languages": "kotlin-swift",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it"
+    ],
+    "version": "0.62.0"
+  }
+}

package/src/FastJson.nitro.ts

@@ -0,0 +1,86 @@
+import type { AnyMap, HybridObject } from 'react-native-nitro-modules';
+
+export interface JsonView extends HybridObject<{
+  ios: 'c++';
+  android: 'c++';
+}> {
+  /**
+   * Returns the raw JSON string of the JSON view.
+   * @returns The raw JSON string of the JSON view.
+   */
+  rawJson(): string;
+  /**
+   * Returns the value of the key in the JSON view.
+   * @param key The key to get the value of. Must be a single key, not a path.
+   * @returns The value of the key in the JSON view.
+   */
+  getValue(key: string): JsonView | null;
+  /**
+   * Returns all the keys or fields of an object or array.
+   * Only for objects or arrays.
+   * @returns The keys of the JSON view.
+   */
+  keys(): string[];
+  /**
+   * Only for arrays. Returns the value of the index of an array.
+   * @param index The index to get the value from an array.
+   * @returns The value of the index in the array.
+   */
+  at(index: number): JsonView | null;
+  /**
+   * Returns all the values of the path specified.
+   * @param path simple path e.g $.key1.key2.key3. Indexing is not supported.
+   * @returns Returns a JsonView.
+   */
+  atPath(path: string /* $.key1.key2.key3 */): JsonView | null;
+  /**
+   * For dynamic retrieval of nested values with wildcards.
+   * Supports indexing with [*] or [number].
+   * @param path Must begin with $. e.g $.key1[*].key2[1]
+   * @returns all the values of the path specified.
+   */
+  atPathWithWildcard(path: string /* $.key1[*].key2[1] */): string[] | null;
+  /**
+   * Type of the value. e.g string, number, boolean, object, array.
+   */
+  type: string;
+  /**
+   * Only for objects or arrays.
+   * @returns The length of the value. 0 for other types.
+   */
+  length: number;
+  /**
+   * Returns the value as a string.
+   * @returns The value as a string.
+   */
+  asString(): string;
+  asNumber(): number;
+  asBoolean(): boolean;
+  /**
+   * For casting to JS objects or arrays.
+   * Only if element is an object or array.
+   * @returns `{data: Record<string, any> | any[]}`.
+   */
+  asObject(): AnyMap;
+}
+
+export interface FastJson extends HybridObject<{
+  ios: 'c++';
+  android: 'c++';
+}> {
+  /**
+   * Parses a JSON string and returns a Promise that resolves to a JsonView.
+   * Not ideal, prefer parseFile or use simple JSON.parse if possible.
+   * @param str The JSON string.
+   * @returns A Promise that resolves to a JsonView or null. Response is not cached.
+   */
+  parseString(str: string): Promise<JsonView | null>;
+  /**
+   * Parses a JSON file and returns a Promise that resolves to a JsonView.
+   * No check is done if invalid path is provided. Error handling is left to the caller.
+   * @param path The path to the JSON file.
+   * @returns A Promise that resolves to a JsonView or null. Response is cached for future calls.
+   */
+  parseFile(path: string): Promise<JsonView | null>;
+  release(source: string): void;
+}

package/src/index.tsx

@@ -0,0 +1,6 @@
+import { NitroModules } from 'react-native-nitro-modules';
+
+import type { FastJson, JsonView } from './FastJson.nitro';
+
+export const fastJson = NitroModules.createHybridObject<FastJson>('FastJson');
+export type { JsonView };