react-native-nitro-storage 0.1.0

package/nitrogen/generated/ios/NitroStorageAutolinking.swift

@@ -0,0 +1,12 @@
+///
+/// NitroStorageAutolinking.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+public final class NitroStorageAutolinking {
+  public typealias bridge = margelo.nitro.NitroStorage.bridge.swift
+
+  
+}

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

@@ -0,0 +1,24 @@
+///
+/// HybridStorageSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#include "HybridStorageSpec.hpp"
+
+namespace margelo::nitro::NitroStorage {
+
+  void HybridStorageSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("set", &HybridStorageSpec::set);
+      prototype.registerHybridMethod("get", &HybridStorageSpec::get);
+      prototype.registerHybridMethod("remove", &HybridStorageSpec::remove);
+      prototype.registerHybridMethod("addOnChange", &HybridStorageSpec::addOnChange);
+    });
+  }
+
+} // namespace margelo::nitro::NitroStorage

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

@@ -0,0 +1,67 @@
+///
+/// HybridStorageSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 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 <optional>
+#include <functional>
+
+namespace margelo::nitro::NitroStorage {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `Storage`
+   * Inherit this class to create instances of `HybridStorageSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridStorage: public HybridStorageSpec {
+   * public:
+   *   HybridStorage(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridStorageSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridStorageSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridStorageSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual void set(const std::string& key, const std::string& value, double scope) = 0;
+      virtual std::optional<std::string> get(const std::string& key, double scope) = 0;
+      virtual void remove(const std::string& key, double scope) = 0;
+      virtual std::function<void()> addOnChange(double scope, const std::function<void(const std::string& /* key */, const std::optional<std::string>& /* value */)>& callback) = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "Storage";
+  };
+
+} // namespace margelo::nitro::NitroStorage

package/package.json

@@ -0,0 +1,117 @@
+{
+  "name": "react-native-nitro-storage",
+  "version": "0.1.0",
+  "description": "The fastest, most complete storage solution for React Native. Synchronous Memory, Disk, and Secure storage in one unified API. Built with Nitro Modules.",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index.ts",
+  "source": "src/index.ts",
+  "files": [
+    "src",
+    "lib",
+    "cpp",
+    "android",
+    "ios",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "app.plugin.js",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!cpp/core/*Test.cpp",
+    "!cpp/build",
+    "!android/build",
+    "!android/.cxx",
+    "!scripts"
+  ],
+  "scripts": {
+    "prebuild": "npm run codegen",
+    "build": "bob build",
+    "clean": "rimraf lib nitrogen/generated",
+    "codegen": "nitrogen --logLevel=\"debug\"",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:cpp": "node scripts/test-cpp.js",
+    "prepublishOnly": "npm run clean && npm run build",
+    "prepack": "node -e \"const fs=require('fs'); fs.copyFileSync('../../README.md','./README.md'); try{fs.copyFileSync('../../LICENSE','./LICENSE')}catch(e){}\"",
+    "postpack": "node -e \"const fs=require('fs'); ['./README.md','./LICENSE'].forEach(f=>fs.existsSync(f)&&fs.unlinkSync(f))\""
+  },
+  "keywords": [
+    "react-native",
+    "storage",
+    "nitro",
+    "jsi",
+    "synchronous",
+    "state-management",
+    "mmkv",
+    "async-storage",
+    "secure-store",
+    "keychain",
+    "persistence",
+    "zustand",
+    "jotai",
+    "encrypted-storage",
+    "react-native-storage",
+    "native-module",
+    "performance",
+    "fast-storage"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JoaoPauloCMarra/react-native-nitro-storage.git"
+  },
+  "author": "JoaoPauloCMarra",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/JoaoPauloCMarra/react-native-nitro-storage/issues"
+  },
+  "homepage": "https://github.com/JoaoPauloCMarra/react-native-nitro-storage#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@expo/config-plugins": "^54.0.4",
+    "@react-native/babel-preset": "^0.83.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/react-native": "^13.3.3",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.0",
+    "jest": "^29.7.0",
+    "nitrogen": "^0.31.10",
+    "react": "19.1.0",
+    "react-native": "0.81.5",
+    "react-native-builder-bob": "^0.31.0",
+    "react-native-nitro-modules": "^0.31.10",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": ">=0.75.0",
+    "react-native-nitro-modules": ">=0.31.0"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      "typescript"
+    ]
+  }
+}

package/react-native-nitro-storage.podspec

@@ -0,0 +1,36 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-nitro-storage"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :git => "https://github.com/JoaoPauloCMarra/react-native-nitro-storage.git", :tag => "#{s.version}" }
+
+  s.source_files = [
+    "ios/**/*.{h,m,mm,swift}",
+    "cpp/**/*.{h,hpp,c,cpp}"
+  ]
+
+  s.pod_target_xcconfig = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
+    "CLANG_CXX_LIBRARY" => "libc++",
+    "HEADER_SEARCH_PATHS" => [
+      "\"$(PODS_TARGET_SRCROOT)/cpp/core\"",
+      "\"$(PODS_TARGET_SRCROOT)/cpp/bindings\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/shared/c++\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/ios\""
+    ].join(" ")
+  }
+
+  s.dependency "React-Core"
+  
+  load 'nitrogen/generated/ios/NitroStorage+autolinking.rb'
+  add_nitrogen_files(s)
+end

package/src/Storage.nitro.ts

@@ -0,0 +1,17 @@
+import type { HybridObject } from "react-native-nitro-modules";
+
+export enum StorageScope {
+  Memory = 0,
+  Disk = 1,
+  Secure = 2,
+}
+
+export interface Storage extends HybridObject<{ ios: "c++"; android: "c++" }> {
+  set(key: string, value: string, scope: number): void;
+  get(key: string, scope: number): string | undefined;
+  remove(key: string, scope: number): void;
+  addOnChange(
+    scope: number,
+    callback: (key: string, value: string | undefined) => void
+  ): () => void;
+}

package/src/index.ts

@@ -0,0 +1,113 @@
+import { useSyncExternalStore } from "react";
+import { NitroModules } from "react-native-nitro-modules";
+import type { Storage, StorageScope } from "./Storage.nitro";
+
+export { StorageScope } from "./Storage.nitro";
+export type { Storage } from "./Storage.nitro";
+
+let _storageModule: Storage | null = null;
+
+function getStorageModule(): Storage {
+  if (!_storageModule) {
+    _storageModule = NitroModules.createHybridObject<Storage>("Storage");
+  }
+  return _storageModule!;
+}
+
+export interface StorageItemConfig<T> {
+  key: string;
+  scope: StorageScope;
+  defaultValue?: T;
+  serialize?: (value: T) => string;
+  deserialize?: (value: string) => T;
+}
+
+export interface StorageItem<T> {
+  get: () => T;
+  set: (value: T) => void;
+  delete: () => void;
+  subscribe: (callback: () => void) => () => void;
+}
+
+function defaultSerialize<T>(value: T): string {
+  return JSON.stringify(value);
+}
+
+function defaultDeserialize<T>(value: string): T {
+  return JSON.parse(value) as T;
+}
+
+export function createStorageItem<T = undefined>(
+  config: StorageItemConfig<T>
+): StorageItem<T> {
+  const serialize = config.serialize ?? defaultSerialize;
+  const deserialize = config.deserialize ?? defaultDeserialize;
+
+  const listeners = new Set<() => void>();
+
+  let unsubscribe: (() => void) | null = null;
+
+  const ensureSubscription = () => {
+    if (!unsubscribe) {
+      unsubscribe = getStorageModule().addOnChange(config.scope, (key) => {
+        if (key === config.key) {
+          listeners.forEach((listener) => listener());
+        }
+      });
+    }
+  };
+
+  let lastRaw: string | undefined;
+  let lastValue: T | undefined;
+
+  const get = (): T => {
+    const raw = getStorageModule().get(config.key, config.scope);
+
+    if (raw === lastRaw && lastValue !== undefined) {
+      return lastValue;
+    }
+
+    lastRaw = raw;
+
+    if (raw === undefined) {
+      lastValue = config.defaultValue as T;
+    } else {
+      lastValue = deserialize(raw);
+    }
+
+    return lastValue;
+  };
+
+  const set = (value: T): void => {
+    const serialized = serialize(value);
+    getStorageModule().set(config.key, serialized, config.scope);
+  };
+
+  const deleteItem = (): void => {
+    getStorageModule().remove(config.key, config.scope);
+  };
+
+  const subscribe = (callback: () => void): (() => void) => {
+    ensureSubscription();
+    listeners.add(callback);
+    return () => {
+      listeners.delete(callback);
+      if (listeners.size === 0 && unsubscribe) {
+        unsubscribe();
+        unsubscribe = null;
+      }
+    };
+  };
+
+  return {
+    get,
+    set,
+    delete: deleteItem,
+    subscribe,
+  };
+}
+
+export function useStorage<T>(item: StorageItem<T>): [T, (value: T) => void] {
+  const value = useSyncExternalStore(item.subscribe, item.get, item.get);
+  return [value, item.set];
+}