npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@crabnebula/ota-updater

v0.1.4

Published

This plugin provides over-the-air (OTA) updates for the Web assets of a Tauri app.

Downloads

6

Readme

Over-the-air (OTA) Updater

This plugin provides over-the-air (OTA) updates for the Web assets of a Tauri app.

It leverages the CrabNebula Cloud to ship the assets.

Install

This plugin requires a Rust version of at least 1.75

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-ota-updater = "2.0.0-rc"

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add @crabnebula/plugin-ota-updater
# or
npm add @crabnebula/plugin-ota-updater
# or
yarn add @crabnebula/plugin-ota-updater

Configuration

You need a signing key to sign the update bundle. This ensures the integrity of your code can be checked at runtime. To generate a new signing key run the generate-keypair command:

npx @crabnebula/ota-updater generate-keypair

Safely store the private key and DO NOT share it with anyone. It will be required to distribute updates later.

The plugin must be configured with the signing public key and CrabNebula Cloud org/app slug pair:

{
    "plugins": {
        "ota-updater": {
            "orgSlug": "my-org",
            "appSlug": "my-app",
            "pubkey": "<insert-public-key-here>"
        }
    }
}

To be able to use the updater from the frontend of your application you need to enable the default permission of the plugin in your capability ( e.g. capabilities/default.json):

{
...
  "permissions": [
    "ota-updater:default"
  ]
...
}

Distributing Updates

To distribute updates, build your frontend assets and then run the upload command providing the private key and a CrabNebula Cloud API key as environment variables:

export PRIVATE_KEY=<insert-private-key-here>
export CN_API_KEY=<insert api-key-here>
npx @crabnebula/ota-updater upload

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

fn main() {
    let context = tauri::generate_context!();

    let (ota_plugin, context) = tauri_plugin_ota_updater::init(context);

    tauri::Builder::default()
        .plugin(ota_plugin)
        .run(context)
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { check } from "@crabnebula/plugin-ota-updater";
const update = await check()
if (update) {
    await update.apply()
    location.reload()
}

License

Code: (c) 2023 - Present - CrabNebula Ltd.

PolyForm-Noncommercial-1.0.0