SDK Installation

Install via npm


npm install @norrix/client-sdk

Platform Support

Platform	Minimum NativeScript Version
iOS	8.0.0
Android	8.0.0

What’s Included

The SDK package includes:

TypeScript SDK

The main SDK code for checking and applying OTA updates.

Native Modules

Pre-built native libraries for OTA loading:

iOS: NorrixOTA.xcframework
Android: NorrixAndroidOTA.aar

These modules handle the low-level native code loading that enables OTA updates.

NativeScript Hooks

Automatically configured hooks that run during ns prepare:

Hook	Type	Description
`norrix-ota-ios`	`after-prepare`	Configures iOS OTA loading
`norrix-ota-android`	`after-prepare`	Configures Android OTA loading

The hooks are defined in the package.json and executed automatically.

Dependencies

The SDK installs these dependencies:

Package	Purpose
`@nativescript/zip`	Extracting OTA update bundles

Peer Dependencies

The SDK expects these to be in your project:

Package	Version
`@nativescript/core`	^8.0.0 or ^9.0.0

Verification

After installation, verify the SDK is available:


import { initNorrix } from '@norrix/client-sdk';
 
// If this compiles, the SDK is installed correctly

Project Structure

After installation, your project should include:


node_modules/
  @norrix/
    client-sdk/
      dist/           # Compiled SDK code
      platforms/
        ios/          # iOS native module
        android/      # Android native module
      scripts/        # NativeScript hooks

Next Steps

Configuration: Configure the SDK
Usage Guide: Implement OTA updates