DeepTrekker Updates Library

Overview

This library enables developers to update Deep Trekker and Pipe Trekker products via the front-end applications. It provides several functions that are used throughout the update process such as parsing manifests, fetching apks and routing chunked files.

Pre-requisites

To begin using this library, we require that you set up a compatible TypesScript/JavaScript project with the following dependencies installed and configured:

1. React (17+) — This is a framework for rapidly building user interfaces and is the basis for this SDK.

2. yarn — We recommend using yarn as your package manager.

📦 Installation

1. Open your project

2. Run

   yarn install @deeptrekker/updates

(Internal)

Usage

1. Open the file with the update procedures.

2. Import the required functions

   // updateProvider.tsx
   import { parseManifest } from "@deeptrekker/updates"

3. Use functions

   // updateProvider.tsx
   const checkManifest = (manifest: UpdateManifest) => {
           const checkedManifest = parseManifest(manifest)
           if (checkedManifest.length){
                   return true;
           } else {
                   return false;
           }
   }