react-native-ota-client 0.3.0 → 0.3.2

package/README.md

@@ -1,9 +1,23 @@
 # react-native-ota-client
 
+[![npm version](https://img.shields.io/npm/v/react-native-ota-client.svg)](https://www.npmjs.com/package/react-native-ota-client)
+[![Documentation](https://img.shields.io/badge/docs-docs.ota.arjunis.me-blue)](https://docs.ota.arjunis.me)
+
 Android and iOS OTA update support for React Native applications using the New Architecture and Hermes. The SDK checks for signed releases, verifies the release manifest and packaged bundle, stages verified updates, selects the bundle on cold start, and rolls back a release that does not confirm healthy.
 
 OTA can update JavaScript and bundled assets. Native code, permissions/entitlements, React Native/Hermes versions, and Codegen contract changes require a new APK/IPA.
 
+## Documentation
+
+Full setup and API guides are at [docs.ota.arjunis.me](https://docs.ota.arjunis.me).
+
+- [Installation](https://docs.ota.arjunis.me/guide/installation)
+- [JavaScript API](https://docs.ota.arjunis.me/guide/javascript-api)
+- [Android setup](https://docs.ota.arjunis.me/guide/android)
+- [iOS setup](https://docs.ota.arjunis.me/guide/ios)
+- [Server guide](https://docs.ota.arjunis.me/server/)
+- [Server API and client contract](https://docs.ota.arjunis.me/server/api#client-contract)
+
 ## Requirements and support
 
 - Android and iOS.
@@ -37,8 +51,6 @@ await OTAUpdates.closeAppToApplyUpdate();
 
 On iOS, apps cannot terminate themselves. When `closeAppToApplyUpdate()` returns `true`, ask the user to leave and reopen the app to load the staged bundle.
 
-The package also retains the generated-template `multiply()` example; it is not part of the OTA API.
-
 ## Android configuration
 
 Configure the SDK once in the host application's `Application` class. Initialize it in `onCreate()` before calling `loadReactNative()`, and provide the selected bundle path to React Native's host configuration. The SDK's own `BuildConfig.DEBUG` is not the consumer app's build type.
@@ -128,10 +140,10 @@ Use HTTPS for staging and production, with `allowInsecureHttp = false`. Local de
 
 `OtaSdkUpdates` exposes the Android startup and host integration API:
 
-- `initialize(context, config)` — configure the manager once before use.
-- `beginProcess()` — select/rollback the startup bundle before React Native starts.
-- `bundlePathForReactHost()` — return the selected bundle path, or `null` for the APK bundle.
-- `status()`, `checkForUpdate()`, `markHealthy()`, and `closeAppForUpdate(activity)` — operations used by the TurboModule implementation.
+- `initialize(context, config)` configures the manager once before use.
+- `beginProcess()` selects or rolls back the startup bundle before React Native starts.
+- `bundlePathForReactHost()` returns the selected bundle path, or `null` for the APK bundle.
+- `status()`, `checkForUpdate()`, `markHealthy()`, and `closeAppForUpdate(activity)` are the operations used by the TurboModule implementation.
 
 The SDK autolinks a single `OtaSdkPackage` containing both the sample `OtaSdk` TurboModule and the OTA `OTAUpdates` TurboModule. Do not add another manual package registration in the host app.
 

package/android/src/main/java/com/otasdk/OtaSdkPackage.kt

@@ -9,7 +9,6 @@ import com.facebook.react.module.model.ReactModuleInfoProvider
 class OtaSdkPackage : BaseReactPackage() {
   override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
     return when (name) {
-      OtaSdkModule.NAME -> OtaSdkModule(reactContext)
       OtaUpdatesModule.NAME -> OtaUpdatesModule(reactContext)
       else -> null
     }
@@ -17,7 +16,6 @@ class OtaSdkPackage : BaseReactPackage() {
 
   override fun getReactModuleInfoProvider() = ReactModuleInfoProvider {
     mapOf(
-      OtaSdkModule.NAME to moduleInfo(OtaSdkModule.NAME, OtaSdkModule::class.java.name),
       OtaUpdatesModule.NAME to moduleInfo(OtaUpdatesModule.NAME, OtaUpdatesModule::class.java.name),
     )
   }

package/lib/module/index.js

@@ -1,5 +1,4 @@
 "use strict";
 
-export { multiply } from './multiply';
 export { default as OTAUpdates } from "./NativeOTAUpdates.js";
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["multiply","default","OTAUpdates"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,QAAQ,QAAQ,YAAY;AACrC,SAASC,OAAO,IAAIC,UAAU,QAAQ,uBAAoB","ignoreList":[]}
+{"version":3,"names":["default","OTAUpdates"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,OAAO,IAAIC,UAAU,QAAQ,uBAAoB","ignoreList":[]}

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

@@ -1,4 +1,3 @@
-export { multiply } from './multiply';
 export { default as OTAUpdates } from './NativeOTAUpdates.js';
 export type { OtaUpdateStatus, Spec as OtaUpdatesSpec, } from './NativeOTAUpdates.js';
 //# 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,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,uBAAoB,CAAC;AAC3D,YAAY,EACV,eAAe,EACf,IAAI,IAAI,cAAc,GACvB,MAAM,uBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,uBAAoB,CAAC;AAC3D,YAAY,EACV,eAAe,EACf,IAAI,IAAI,cAAc,GACvB,MAAM,uBAAoB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-ota-client",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Android and iOS OTA updates and over-the-air JavaScript updates for React Native apps",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -61,7 +61,7 @@
   "bugs": {
     "url": "https://github.com/arjunnarangali/react-native-ota-client/issues"
   },
-  "homepage": "https://github.com/arjunnarangali/react-native-ota-client#readme",
+  "homepage": "https://docs.ota.arjunis.me/",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },

package/src/index.tsx

@@ -1,4 +1,3 @@
-export { multiply } from './multiply';
 export { default as OTAUpdates } from './NativeOTAUpdates';
 export type {
   OtaUpdateStatus,

package/android/src/main/java/com/otasdk/OtaSdkModule.kt

@@ -1,15 +0,0 @@
-package com.otasdk
-
-import com.facebook.react.bridge.ReactApplicationContext
-
-class OtaSdkModule(reactContext: ReactApplicationContext) :
-  NativeOtaSdkSpec(reactContext) {
-
-  override fun multiply(a: Double, b: Double): Double {
-    return a * b
-  }
-
-  companion object {
-    const val NAME = NativeOtaSdkSpec.NAME
-  }
-}

package/ios/OtaSdk.h

@@ -1,5 +0,0 @@
-#import <OtaSdkSpec/OtaSdkSpec.h>
-
-@interface OtaSdk : NSObject <NativeOtaSdkSpec>
-
-@end

package/ios/OtaSdk.mm

@@ -1,21 +0,0 @@
-#import "OtaSdk.h"
-
-@implementation OtaSdk
-- (NSNumber *)multiply:(double)a b:(double)b {
-  NSNumber *result = @(a * b);
-
-  return result;
-}
-
-- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
-    (const facebook::react::ObjCTurboModule::InitParams &)params
-{
-  return std::make_shared<facebook::react::NativeOtaSdkSpecJSI>(params);
-}
-
-+ (NSString *)moduleName
-{
-  return @"OtaSdk";
-}
-
-@end

package/lib/module/NativeOtaSdk.js

@@ -1,5 +0,0 @@
-"use strict";
-
-import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('OtaSdk');
-//# sourceMappingURL=NativeOtaSdk.js.map

package/lib/module/NativeOtaSdk.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeOtaSdk.ts"],"mappings":";;AAAA,SAASA,mBAAmB,QAA0B,cAAc;AAMpE,eAAeA,mBAAmB,CAACC,YAAY,CAAO,QAAQ,CAAC","ignoreList":[]}

package/lib/module/multiply.js

@@ -1,6 +0,0 @@
-"use strict";
-
-export function multiply(a, b) {
-  return a * b;
-}
-//# sourceMappingURL=multiply.js.map

package/lib/module/multiply.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["multiply","a","b"],"sourceRoot":"../../src","sources":["multiply.tsx"],"mappings":";;AAAA,OAAO,SAASA,QAAQA,CAACC,CAAS,EAAEC,CAAS,EAAU;EACrD,OAAOD,CAAC,GAAGC,CAAC;AACd","ignoreList":[]}

package/lib/module/multiply.native.js

@@ -1,7 +0,0 @@
-"use strict";
-
-import OtaSdk from "./NativeOtaSdk.js";
-export function multiply(a, b) {
-  return OtaSdk.multiply(a, b);
-}
-//# sourceMappingURL=multiply.native.js.map

package/lib/module/multiply.native.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["OtaSdk","multiply","a","b"],"sourceRoot":"../../src","sources":["multiply.native.tsx"],"mappings":";;AAAA,OAAOA,MAAM,MAAM,mBAAgB;AAEnC,OAAO,SAASC,QAAQA,CAACC,CAAS,EAAEC,CAAS,EAAU;EACrD,OAAOH,MAAM,CAACC,QAAQ,CAACC,CAAC,EAAEC,CAAC,CAAC;AAC9B","ignoreList":[]}

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

@@ -1,7 +0,0 @@
-import { type TurboModule } from 'react-native';
-export interface Spec extends TurboModule {
-    multiply(a: number, b: number): number;
-}
-declare const _default: Spec;
-export default _default;
-//# sourceMappingURL=NativeOtaSdk.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"NativeOtaSdk.d.ts","sourceRoot":"","sources":["../../../src/NativeOtaSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC;;AAED,wBAAgE"}

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

@@ -1,2 +0,0 @@
-export declare function multiply(a: number, b: number): number;
-//# sourceMappingURL=multiply.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"multiply.d.ts","sourceRoot":"","sources":["../../../src/multiply.tsx"],"names":[],"mappings":"AAAA,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAErD"}

package/lib/typescript/src/multiply.native.d.ts

@@ -1,2 +0,0 @@
-export declare function multiply(a: number, b: number): number;
-//# sourceMappingURL=multiply.native.d.ts.map

package/lib/typescript/src/multiply.native.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multiply.native.d.ts","sourceRoot":"","sources":["../../../src/multiply.native.tsx"],"names":[],"mappings":"AAEA,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAErD"}

package/src/NativeOtaSdk.ts

@@ -1,7 +0,0 @@
-import { TurboModuleRegistry, type TurboModule } from 'react-native';
-
-export interface Spec extends TurboModule {
-  multiply(a: number, b: number): number;
-}
-
-export default TurboModuleRegistry.getEnforcing<Spec>('OtaSdk');

package/src/multiply.native.tsx

@@ -1,5 +0,0 @@
-import OtaSdk from './NativeOtaSdk';
-
-export function multiply(a: number, b: number): number {
-  return OtaSdk.multiply(a, b);
-}

package/src/multiply.tsx

@@ -1,3 +0,0 @@
-export function multiply(a: number, b: number): number {
-  return a * b;
-}