react-native-tinykit 0.1.1 → 0.2.0

package/README.md

@@ -3,11 +3,14 @@
 [![npm version](https://img.shields.io/npm/v/react-native-tinykit.svg)](https://www.npmjs.com/package/react-native-tinykit)
 [![license](https://img.shields.io/npm/l/react-native-tinykit.svg)](https://github.com/luoxuhai/react-native-tinykit/blob/master/LICENSE)
 
-A lightweight React Native toolkit for iOS, providing essential native utilities.
+A lightweight React Native toolkit for iOS, providing essential native utilities (Zero dependencies).
+
+<img src="./assets/example.png" width="400" />
 
 ## Features
 
 - 🔄 **App Restart** - Programmatically restart your React Native application
+- 🌡️ **Thermal State** - Get and monitor the device's thermal state
 - ⚡ **Turbo Module** - Built with the new architecture for optimal performance
 - 📦 **Lightweight** - Minimal footprint with zero dependencies
 
@@ -51,6 +54,47 @@ restart();
 - Reset app state after logout
 - Apply configuration changes that require a restart
 
+### Thermal State
+
+Get the current thermal state and monitor for changes:
+
+```tsx
+import { getThermalState, addThermalStateListener } 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) => {
+  console.log('Thermal state changed:', state);
+
+  switch (state) {
+    case 'nominal':
+      // Normal operating conditions
+      break;
+    case 'fair':
+      // Slightly elevated thermal state
+      break;
+    case 'serious':
+      // High thermal state - consider reducing activity
+      break;
+    case 'critical':
+      // Critical thermal state - reduce activity immediately
+      break;
+  }
+});
+
+// Clean up the listener when done
+subscription.remove();
+```
+
+#### Example Use Cases
+
+- Reduce graphics quality or frame rate when device is overheating
+- Pause background tasks during high thermal states
+- Show warnings to users when thermal state is critical
+
 ## API Reference
 
 ### `restart()`
@@ -72,6 +116,68 @@ const handleLogout = async () => {
 };
 ```
 
+### `getThermalState()`
+
+Returns the current thermal state of the device.
+
+```tsx
+getThermalState(): ThermalState
+```
+
+**Returns:** `'nominal' | 'fair' | 'serious' | 'critical'`
+
+| State      | Description                               |
+| ---------- | ----------------------------------------- |
+| `nominal`  | The thermal state is within normal limits |
+| `fair`     | The thermal state is slightly elevated    |
+| `serious`  | The thermal state is high                 |
+| `critical` | The thermal state is critically high      |
+
+**Example:**
+
+```tsx
+import { getThermalState } from 'react-native-tinykit';
+
+const state = getThermalState();
+if (state === 'critical') {
+  // Reduce app activity to help cool down the device
+}
+```
+
+### `addThermalStateListener()`
+
+Adds a listener for thermal state changes.
+
+```tsx
+addThermalStateListener(listener: (state: ThermalState) => void): { remove: () => void }
+```
+
+**Parameters:**
+
+- `listener` - Callback function that receives the new thermal state
+
+**Returns:** A subscription object with a `remove()` method to stop listening
+
+**Example:**
+
+```tsx
+import { addThermalStateListener } from 'react-native-tinykit';
+
+const subscription = addThermalStateListener((state) => {
+  console.log('Thermal state changed to:', state);
+});
+
+// Later, when you want to stop listening:
+subscription.remove();
+```
+
+## Apps Using This Library
+
+- [Night Vision - LiDAR Camera](https://apps.apple.com/app/id1668629667)
+- [Laser Measure - LiDAR Powered](https://apps.apple.com/app/id6466744678)
+- [PhoneAway - Digital Detox](https://apps.apple.com/app/id6744548607)
+- [Fatigue Alert - Stay Awake](https://apps.apple.com/app/id6479893638)
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

package/Tinykit.podspec

@@ -3,7 +3,7 @@ require "json"
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
 Pod::Spec.new do |s|
-  s.name         = "Tinykit"
+  s.name         = "react-native-tinykit"
   s.version      = package["version"]
   s.summary      = package["description"]
   s.homepage     = package["homepage"]

package/ios/Tinykit.h

@@ -1,5 +1,5 @@
 #import <TinykitSpec/TinykitSpec.h>
 
-@interface Tinykit : NSObject <NativeTinykitSpec>
+@interface Tinykit : NativeTinykitSpecBase <NativeTinykitSpec>
 
 @end

package/ios/Tinykit.mm

@@ -3,18 +3,78 @@
 
 @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];
+}
+
+/// 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
+{
+    NSString *state = [Tinykit thermalStateToString:[[NSProcessInfo processInfo] thermalState]];
+    [self emitOnThermalStateChange:@{@"thermalState": state}];
+}
+
+/// 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];
+}
+
+/// Triggers a reload of the React Native bundle on the main thread.
 - (void)restart {
     dispatch_sync(dispatch_get_main_queue(), ^{
       RCTTriggerReloadCommandListeners(@"react-native-tinykit");
     });
 }
 
+/// 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
 {
     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/lib/module/NativeTinykit.js

@@ -1,5 +1,18 @@
 "use strict";
 
 import { TurboModuleRegistry } from 'react-native';
+
+/**
+ * Thermal state values that indicate the current thermal condition of the device.
+ * - 'nominal': The thermal state is within normal limits.
+ * - 'fair': The thermal state is slightly elevated.
+ * - 'serious': The thermal state is high.
+ * - '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,SAASA,mBAAmB,QAA0B,cAAc;AAMpE,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;;AAGA;AACA;AACA;;AAWA,eAAeA,mBAAmB,CAACC,YAAY,CAAO,SAAS,CAAC","ignoreList":[]}

package/lib/module/index.js

@@ -1,11 +1,36 @@
 "use strict";
 
 import Tinykit from "./NativeTinykit.js";
-
 /**
  * Restarts the React Native application.
  */
 export function restart() {
   return Tinykit.restart();
 }
+
+/**
+ * Gets the current thermal state of the device.
+ *
+ * @returns The current thermal state: 'nominal', 'fair', 'serious', or 'critical'
+ */
+export function getThermalState() {
+  return Tinykit.getThermalState();
+}
+
+/**
+ * Callback function type for thermal state change events.
+ */
+
+/**
+ * Adds a listener that will be called when the thermal state changes.
+ *
+ * @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;
+}
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["Tinykit","restart"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,OAAOA,OAAO,MAAM,oBAAiB;;AAErC;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAAA,EAAS;EAC9B,OAAOD,OAAO,CAACC,OAAO,CAAC,CAAC;AAC1B","ignoreList":[]}
+{"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":[]}

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

@@ -1,6 +1,22 @@
-import { type TurboModule } from 'react-native';
+import { type TurboModule, type CodegenTypes } from 'react-native';
+/**
+ * Thermal state values that indicate the current thermal condition of the device.
+ * - 'nominal': The thermal state is within normal limits.
+ * - 'fair': The thermal state is slightly elevated.
+ * - 'serious': The thermal state is high.
+ * - '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>;
 }
 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,EAAuB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,OAAO,IAAI,IAAI,CAAC;CACjB;;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;;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"}

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

@@ -1,5 +1,26 @@
+import { type ThermalState } from './NativeTinykit';
+export type { ThermalState, ThermalStateChangeEvent } from './NativeTinykit';
 /**
  * Restarts the React Native application.
  */
 export declare function restart(): void;
+/**
+ * Gets the current thermal state of the device.
+ *
+ * @returns The current thermal state: 'nominal', 'fair', 'serious', or 'critical'
+ */
+export declare function getThermalState(): ThermalState;
+/**
+ * Callback function type for thermal state change events.
+ */
+export type ThermalStateListener = (state: ThermalState) => void;
+/**
+ * Adds a listener that will be called when the thermal state changes.
+ *
+ * @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): {
+    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":"AAEA;;GAEG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B"}
+{"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"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-tinykit",
-  "version": "0.1.1",
-  "description": "react native tiny kit for ios",
+  "version": "0.2.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",
   "exports": {

package/src/NativeTinykit.ts

@@ -1,7 +1,29 @@
-import { TurboModuleRegistry, type TurboModule } from 'react-native';
+import {
+  TurboModuleRegistry,
+  type TurboModule,
+  type CodegenTypes,
+} from 'react-native';
+
+/**
+ * Thermal state values that indicate the current thermal condition of the device.
+ * - 'nominal': The thermal state is within normal limits.
+ * - 'fair': The thermal state is slightly elevated.
+ * - 'serious': The thermal state is high.
+ * - '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>;
 }
 
 export default TurboModuleRegistry.getEnforcing<Spec>('Tinykit');

package/src/index.tsx

@@ -1,4 +1,9 @@
-import Tinykit from './NativeTinykit';
+import Tinykit, {
+  type ThermalState,
+  type ThermalStateChangeEvent,
+} from './NativeTinykit';
+
+export type { ThermalState, ThermalStateChangeEvent } from './NativeTinykit';
 
 /**
  * Restarts the React Native application.
@@ -6,3 +11,34 @@ import Tinykit from './NativeTinykit';
 export function restart(): void {
   return Tinykit.restart();
 }
+
+/**
+ * Gets the current thermal state of the device.
+ *
+ * @returns The current thermal state: 'nominal', 'fair', 'serious', or 'critical'
+ */
+export function getThermalState(): ThermalState {
+  return Tinykit.getThermalState();
+}
+
+/**
+ * Callback function type for thermal state change events.
+ */
+export type ThermalStateListener = (state: ThermalState) => void;
+
+/**
+ * Adds a listener that will be called when the thermal state changes.
+ *
+ * @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): {
+  remove: () => void;
+} {
+  const subscription = Tinykit.onThermalStateChange(
+    (event: ThermalStateChangeEvent) => {
+      listener(event.thermalState);
+    }
+  );
+  return subscription;
+}