react-native-tinykit 0.2.0 → 0.4.0

package/README.md

@@ -11,6 +11,7 @@ A lightweight React Native toolkit for iOS, providing essential native utilities
 
 - 🔄 **App Restart** - Programmatically restart your React Native application
 - 🌡️ **Thermal State** - Get and monitor the device's thermal state
+- ⭐ **App Review** - Request App Store review from within your app
 - ⚡ **Turbo Module** - Built with the new architecture for optimal performance
 - 📦 **Lightweight** - Minimal footprint with zero dependencies
 
@@ -59,14 +60,14 @@ restart();
 Get the current thermal state and monitor for changes:
 
 ```tsx
-import { getThermalState, addThermalStateListener } from 'react-native-tinykit';
+import { getThermalState, onThermalStateChange } from 'react-native-tinykit';
 
 // Get current thermal state
 const state = getThermalState();
 console.log('Current thermal state:', state);
 
 // Listen for thermal state changes
-const subscription = addThermalStateListener((state) => {
+const subscription = onThermalStateChange((state) => {
   console.log('Thermal state changed:', state);
 
   switch (state) {
@@ -95,6 +96,24 @@ subscription.remove();
 - Pause background tasks during high thermal states
 - Show warnings to users when thermal state is critical
 
+### App Review
+
+Request an App Store review from your user:
+
+```tsx
+import { requestReview } from 'react-native-tinykit';
+
+// Request review
+await requestReview();
+```
+
+> **Note**: In development mode, the review dialog will always appear. In production (TestFlight/App Store), iOS limits the frequency of these prompts (max 3 times per year per user).
+
+#### Example Use Cases
+
+- Prompt for review after a user completes a significant action
+- Ask for feedback after a certain number of app opens
+
 ## API Reference
 
 ### `restart()`
@@ -144,12 +163,12 @@ if (state === 'critical') {
 }
 ```
 
-### `addThermalStateListener()`
+### `onThermalStateChange()`
 
 Adds a listener for thermal state changes.
 
 ```tsx
-addThermalStateListener(listener: (state: ThermalState) => void): { remove: () => void }
+onThermalStateChange(listener: (state: ThermalState) => void): { remove: () => void }
 ```
 
 **Parameters:**
@@ -161,9 +180,9 @@ addThermalStateListener(listener: (state: ThermalState) => void): { remove: () =
 **Example:**
 
 ```tsx
-import { addThermalStateListener } from 'react-native-tinykit';
+import { onThermalStateChange } from 'react-native-tinykit';
 
-const subscription = addThermalStateListener((state) => {
+const subscription = onThermalStateChange((state) => {
   console.log('Thermal state changed to:', state);
 });
 
@@ -171,6 +190,30 @@ const subscription = addThermalStateListener((state) => {
 subscription.remove();
 ```
 
+### `requestReview()`
+
+Requests a review of the app.
+
+```tsx
+requestReview(): Promise<void>
+```
+
+**Returns:** A Promise that resolves when the request is processed.
+
+**Example:**
+
+```tsx
+import { requestReview } from 'react-native-tinykit';
+
+const handleReview = async () => {
+  try {
+    await requestReview();
+  } catch (error) {
+    console.error('Failed to request review:', error);
+  }
+};
+```
+
 ## Apps Using This Library
 
 - [Night Vision - LiDAR Camera](https://apps.apple.com/app/id1668629667)

package/ios/Tinykit.h

@@ -1,4 +1,5 @@
 #import <TinykitSpec/TinykitSpec.h>
+#import <React/RCTReloadCommand.h>
 
 @interface Tinykit : NativeTinykitSpecBase <NativeTinykitSpec>
 

package/ios/Tinykit.mm

@@ -1,80 +1,41 @@
 #import "Tinykit.h"
-#import <React/RCTReloadCommand.h>
+#import "react_native_tinykit-Swift.h"
 
-@implementation Tinykit
-
-/// Initializes the Tinykit module and registers for thermal state change notifications.
-- (instancetype)init
-{
-    self = [super init];
-    if (self) {
-        [[NSNotificationCenter defaultCenter] addObserver:self
-                                                 selector:@selector(thermalStateChange:)
-                                                     name:NSProcessInfoThermalStateDidChangeNotification
-                                                   object:nil];
-    }
-    return self;
-}
-
-/// Cleans up by removing the observer from the notification center.
-- (void)dealloc
-{
-    [[NSNotificationCenter defaultCenter] removeObserver:self];
+@implementation Tinykit {
+  NativeTinykit *_nativeTinykit;
 }
 
-/// Converts a thermal state enum value to its string representation.
-/// @param thermalState The thermal state to convert.
-/// @return A string representation of the thermal state ("nominal", "fair", "serious", or "critical").
-+ (NSString *)thermalStateToString:(NSProcessInfoThermalState)thermalState
-{
-    switch (thermalState) {
-        case NSProcessInfoThermalStateNominal:
-            return @"nominal";
-        case NSProcessInfoThermalStateFair:
-            return @"fair";
-        case NSProcessInfoThermalStateSerious:
-            return @"serious";
-        case NSProcessInfoThermalStateCritical:
-            return @"critical";
-        default:
-            return @"nominal";
-    }
-}
-
-/// Handles thermal state change notifications from the system.
-/// @param notification The notification containing thermal state change information.
-- (void)thermalStateChange:(NSNotification *)notification
+- (instancetype)init
 {
-    NSString *state = [Tinykit thermalStateToString:[[NSProcessInfo processInfo] thermalState]];
-    [self emitOnThermalStateChange:@{@"thermalState": state}];
+  self = [super init];
+  if (self) {
+    __weak Tinykit *weakSelf = self;
+    _nativeTinykit = [[NativeTinykit alloc] initOnThermalStateChange:^(NSString *value) {
+      [weakSelf emitOnThermalStateChange:value];
+    }];
+  }
+  return self;
 }
 
-/// Returns the current thermal state of the device as a string.
-/// @return A string representation of the current thermal state.
 - (NSString *)getThermalState
 {
-    NSProcessInfoThermalState thermalState = [[NSProcessInfo processInfo] thermalState];
-    return [Tinykit thermalStateToString:thermalState];
+  return [_nativeTinykit getThermalState];
 }
 
-/// Triggers a reload of the React Native bundle on the main thread.
 - (void)restart {
-    dispatch_sync(dispatch_get_main_queue(), ^{
-      RCTTriggerReloadCommandListeners(@"react-native-tinykit");
-    });
+  [_nativeTinykit restart];
+}
+
+- (void)requestReview:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+  [_nativeTinykit requestReviewWithResolve:resolve rejecter:reject];
 }
 
-/// Returns the TurboModule instance for this native module.
-/// @param params The initialization parameters for the TurboModule.
-/// @return A shared pointer to the TurboModule instance.
 - (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
-    (const facebook::react::ObjCTurboModule::InitParams &)params
+(const facebook::react::ObjCTurboModule::InitParams &)params
 {
-    return std::make_shared<facebook::react::NativeTinykitSpecJSI>(params);
+  return std::make_shared<facebook::react::NativeTinykitSpecJSI>(params);
 }
 
-/// Returns the name of this native module used for JavaScript bridge registration.
-/// @return The module name "Tinykit".
 + (NSString *)moduleName
 {
   return @"Tinykit";

package/ios/Tinykit.swift

@@ -0,0 +1,72 @@
+import Foundation
+import React
+import StoreKit
+
+@objcMembers public class NativeTinykit: NSObject {
+  public var onThermalStateChange: ((String) -> Void)?
+
+  public init(onThermalStateChange: @escaping ((String) -> Void)) {
+    super.init()
+    self.onThermalStateChange = onThermalStateChange
+    NotificationCenter.default.addObserver(
+      self,
+      selector: #selector(handleThermalStateChange),
+      name: ProcessInfo.thermalStateDidChangeNotification,
+      object: nil
+    )
+  }
+
+  deinit {
+    NotificationCenter.default.removeObserver(self)
+  }
+
+  public func getThermalState() -> String {
+    return thermalStateToString(ProcessInfo.processInfo.thermalState)
+  }
+
+  public func restart() {
+    DispatchQueue.main.async {
+      RCTTriggerReloadCommandListeners("react-native-tinykit")
+    }
+  }
+
+  public func requestReview(
+    resolve: @escaping RCTPromiseResolveBlock, rejecter reject: RCTPromiseRejectBlock
+  ) {
+    let activeWindowScene = UIApplication.shared.connectedScenes.filter { scene in
+      return scene.activationState == .foregroundActive && scene is UIWindowScene
+    }.first
+
+    if let scene = activeWindowScene as? UIWindowScene {
+      if #available(iOS 16.0, *) {
+        Task {
+          await MainActor.run {
+            AppStore.requestReview(in: scene)
+            resolve(nil)
+          }
+        }
+      } else {
+        SKStoreReviewController.requestReview(in: scene)
+        resolve(nil)
+      }
+    } else {
+      SKStoreReviewController.requestReview()
+      resolve(nil)
+    }
+  }
+
+  @objc private func handleThermalStateChange() {
+    let state = getThermalState()
+    onThermalStateChange?(state)
+  }
+
+  private func thermalStateToString(_ state: ProcessInfo.ThermalState) -> String {
+    switch state {
+    case .nominal: return "nominal"
+    case .fair: return "fair"
+    case .serious: return "serious"
+    case .critical: return "critical"
+    @unknown default: return "nominal"
+    }
+  }
+}

package/lib/module/NativeTinykit.js

@@ -10,9 +10,5 @@ import { TurboModuleRegistry } from 'react-native';
  * - 'critical': The thermal state is critically high.
  */
 
-/**
- * Event payload for thermal state change events.
- */
-
 export default TurboModuleRegistry.getEnforcing('Tinykit');
 //# sourceMappingURL=NativeTinykit.js.map

package/lib/module/NativeTinykit.js.map

@@ -1 +1 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeTinykit.ts"],"mappings":";;AAAA,SACEA,mBAAmB,QAGd,cAAc;;AAErB;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAWA,eAAeA,mBAAmB,CAACC,YAAY,CAAO,SAAS,CAAC","ignoreList":[]}
+{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeTinykit.ts"],"mappings":";;AAAA,SACEA,mBAAmB,QAGd,cAAc;;AAErB;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,eAAeA,mBAAmB,CAACC,YAAY,CAAO,SAAS,CAAC","ignoreList":[]}

package/lib/module/index.js

@@ -17,6 +17,15 @@ export function getThermalState() {
   return Tinykit.getThermalState();
 }
 
+/**
+ * Requests a review of the app.
+ *
+ * @returns A promise that resolves when the review request is processed.
+ */
+export function requestReview() {
+  return Tinykit.requestReview();
+}
+
 /**
  * Callback function type for thermal state change events.
  */
@@ -27,10 +36,7 @@ export function getThermalState() {
  * @param listener - Callback function that receives the new thermal state
  * @returns A subscription object with a remove method to stop listening
  */
-export function addThermalStateListener(listener) {
-  const subscription = Tinykit.onThermalStateChange(event => {
-    listener(event.thermalState);
-  });
-  return subscription;
+export function onThermalStateChange(listener) {
+  return Tinykit.onThermalStateChange(listener);
 }
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["Tinykit","restart","getThermalState","addThermalStateListener","listener","subscription","onThermalStateChange","event","thermalState"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,OAAOA,OAAO,MAGP,oBAAiB;AAIxB;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAAA,EAAS;EAC9B,OAAOD,OAAO,CAACC,OAAO,CAAC,CAAC;AAC1B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAAA,EAAiB;EAC9C,OAAOF,OAAO,CAACE,eAAe,CAAC,CAAC;AAClC;;AAEA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAACC,QAA8B,EAEpE;EACA,MAAMC,YAAY,GAAGL,OAAO,CAACM,oBAAoB,CAC9CC,KAA8B,IAAK;IAClCH,QAAQ,CAACG,KAAK,CAACC,YAAY,CAAC;EAC9B,CACF,CAAC;EACD,OAAOH,YAAY;AACrB","ignoreList":[]}
+{"version":3,"names":["Tinykit","restart","getThermalState","requestReview","onThermalStateChange","listener"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,OAAOA,OAAO,MAA6B,oBAAiB;AAI5D;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAAA,EAAS;EAC9B,OAAOD,OAAO,CAACC,OAAO,CAAC,CAAC;AAC1B;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAAA,EAAiB;EAC9C,OAAOF,OAAO,CAACE,eAAe,CAAC,CAAC;AAClC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAAA,EAAkB;EAC7C,OAAOH,OAAO,CAACG,aAAa,CAAC,CAAC;AAChC;;AAEA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAACC,QAA8B,EAEjE;EACA,OAAOL,OAAO,CAACI,oBAAoB,CAACC,QAAQ,CAAC;AAC/C","ignoreList":[]}

package/lib/typescript/src/NativeTinykit.d.ts

@@ -7,16 +7,11 @@ import { type TurboModule, type CodegenTypes } from 'react-native';
  * - 'critical': The thermal state is critically high.
  */
 export type ThermalState = 'nominal' | 'fair' | 'serious' | 'critical';
-/**
- * Event payload for thermal state change events.
- */
-export type ThermalStateChangeEvent = {
-    thermalState: ThermalState;
-};
 export interface Spec extends TurboModule {
     restart(): void;
     getThermalState(): ThermalState;
-    readonly onThermalStateChange: CodegenTypes.EventEmitter<ThermalStateChangeEvent>;
+    requestReview(): Promise<void>;
+    readonly onThermalStateChange: CodegenTypes.EventEmitter<ThermalState>;
 }
 declare const _default: Spec;
 export default _default;

package/lib/typescript/src/NativeTinykit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeTinykit.d.ts","sourceRoot":"","sources":["../../../src/NativeTinykit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,cAAc,CAAC;AAEtB;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,OAAO,IAAI,IAAI,CAAC;IAChB,eAAe,IAAI,YAAY,CAAC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,YAAY,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;CACnF;;AAED,wBAAiE"}
+{"version":3,"file":"NativeTinykit.d.ts","sourceRoot":"","sources":["../../../src/NativeTinykit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,cAAc,CAAC;AAEtB;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,OAAO,IAAI,IAAI,CAAC;IAChB,eAAe,IAAI,YAAY,CAAC;IAChC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,QAAQ,CAAC,oBAAoB,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;CACxE;;AAED,wBAAiE"}

package/lib/typescript/src/index.d.ts

@@ -1,5 +1,5 @@
 import { type ThermalState } from './NativeTinykit';
-export type { ThermalState, ThermalStateChangeEvent } from './NativeTinykit';
+export type { ThermalState } from './NativeTinykit';
 /**
  * Restarts the React Native application.
  */
@@ -10,6 +10,12 @@ export declare function restart(): void;
  * @returns The current thermal state: 'nominal', 'fair', 'serious', or 'critical'
  */
 export declare function getThermalState(): ThermalState;
+/**
+ * Requests a review of the app.
+ *
+ * @returns A promise that resolves when the review request is processed.
+ */
+export declare function requestReview(): Promise<void>;
 /**
  * Callback function type for thermal state change events.
  */
@@ -20,7 +26,7 @@ export type ThermalStateListener = (state: ThermalState) => void;
  * @param listener - Callback function that receives the new thermal state
  * @returns A subscription object with a remove method to stop listening
  */
-export declare function addThermalStateListener(listener: ThermalStateListener): {
+export declare function onThermalStateChange(listener: ThermalStateListener): {
     remove: () => void;
 };
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAgB,EACd,KAAK,YAAY,EAElB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAE7E;;GAEG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,oBAAoB,GAAG;IACvE,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CAOA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAgB,EAAE,KAAK,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE7D,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;GAEG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAE7C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,GAAG;IACpE,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB,CAEA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-tinykit",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A lightweight React Native toolkit for iOS, providing essential native utilities (Zero dependencies)",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",

package/src/NativeTinykit.ts

@@ -13,17 +13,11 @@ import {
  */
 export type ThermalState = 'nominal' | 'fair' | 'serious' | 'critical';
 
-/**
- * Event payload for thermal state change events.
- */
-export type ThermalStateChangeEvent = {
-  thermalState: ThermalState;
-};
-
 export interface Spec extends TurboModule {
   restart(): void;
   getThermalState(): ThermalState;
-  readonly onThermalStateChange: CodegenTypes.EventEmitter<ThermalStateChangeEvent>;
+  requestReview(): Promise<void>;
+  readonly onThermalStateChange: CodegenTypes.EventEmitter<ThermalState>;
 }
 
 export default TurboModuleRegistry.getEnforcing<Spec>('Tinykit');

package/src/index.tsx

@@ -1,9 +1,6 @@
-import Tinykit, {
-  type ThermalState,
-  type ThermalStateChangeEvent,
-} from './NativeTinykit';
+import Tinykit, { type ThermalState } from './NativeTinykit';
 
-export type { ThermalState, ThermalStateChangeEvent } from './NativeTinykit';
+export type { ThermalState } from './NativeTinykit';
 
 /**
  * Restarts the React Native application.
@@ -21,6 +18,15 @@ export function getThermalState(): ThermalState {
   return Tinykit.getThermalState();
 }
 
+/**
+ * Requests a review of the app.
+ *
+ * @returns A promise that resolves when the review request is processed.
+ */
+export function requestReview(): Promise<void> {
+  return Tinykit.requestReview();
+}
+
 /**
  * Callback function type for thermal state change events.
  */
@@ -32,13 +38,8 @@ export type ThermalStateListener = (state: ThermalState) => void;
  * @param listener - Callback function that receives the new thermal state
  * @returns A subscription object with a remove method to stop listening
  */
-export function addThermalStateListener(listener: ThermalStateListener): {
+export function onThermalStateChange(listener: ThermalStateListener): {
   remove: () => void;
 } {
-  const subscription = Tinykit.onThermalStateChange(
-    (event: ThermalStateChangeEvent) => {
-      listener(event.thermalState);
-    }
-  );
-  return subscription;
+  return Tinykit.onThermalStateChange(listener);
 }