Client SDK

The Norrix Client SDK (@norrix/client-sdk) enables over-the-air (OTA) updates in your NativeScript applications.

Features

Automatic Updates: Check for and install updates on app launch
Manual Control: Full programmatic control over update flow
Fingerprint Checking: Automatic native compatibility verification
Progress Callbacks: Real-time download progress
Status Callbacks: Detailed sync status updates
Offline Resilient: Graceful handling of network issues

Quick Start

1. Install


npm install @norrix/client-sdk

2. Initialize

Add to your app.ts or main.ts:


import { initNorrix } from '@norrix/client-sdk';
 
initNorrix({
  updateUrl: 'https://norrix.net',
  checkForUpdatesOnLaunch: true,
  installUpdatesAutomatically: true,
});

3. Build and Deploy

Create your store build with fingerprinting:


norrix build ios release

4. Publish Updates

Push JavaScript updates instantly:


norrix update ios 1.0.1

How It Works

Build Time: Norrix computes a fingerprint of your native dependencies
Store Release: Your app is published with the bundled fingerprint
Update Check: On launch, the SDK checks for compatible updates
Download: If compatible, the update bundle is downloaded
Install: The bundle is extracted and prepared
Apply: On next app restart, the update is active

What Can Be Updated

✅ Can Update	❌ Requires Store Build
JavaScript/TypeScript code	NativeScript platform versions
CSS/SCSS styles	Native plugin version changes
Assets (images, fonts)	App_Resources contents
Non-native npm packages	Custom native code

Next Steps

Installation: Detailed setup instructions
Configuration: All configuration options
Usage Guide: Automatic vs manual updates
Sync Status: Understanding status callbacks
API Reference: Complete API documentation