Wesa

Wesa enables you to perform storage schema migrations for browser extensions packaged with webpack.

Installation

npm install wesa

Usage

The wesa CLI tool is used to set up and configure revisions.

wesa init

Create a new repository for storage revisions

Options:
  -l, --location  Repository location              [string] [default: "storage"]

wesa revision

Create a new storage revision

Options:
  -m, --message   Revision description                       [string] [required]
  -l, --location  Repository location              [string] [default: "storage"]
  -s, --storage   Storage area
                          [string] [choices: "local", "sync"] [default: "local"]

Initiate a repository that will hold revisions and create your first revision.

wesa init
wesa revision -m "Revision description"

A revision module will be created at storage/revisions. Import the dependencies that are needed to perform the revision and edit the upgrade function to declare storage changes.

A revision is made by modifying the changes object, which is persisted to storage at the end of the function.

async function upgrade() {
  const changes = {};

  // migration code goes here, ex:
  // changes.color = '#fff'

  changes.storageVersion = revision;
  return browser.storage.local.set(changes);
}

Call migrate from the background script to perform a migration.

import {migrate} from 'wesa';

async function init() {
  const context = {
    getAvailableRevisions: async ({area} = {}) =>
      (
        await import(/* webpackMode: "eager" */ 'storage/config.json', {
          with: {type: 'json'}
        })
      ).revisions[area],
    getCurrentRevision: async ({area} = {}) =>
      (await browser.storage[area].get('storageVersion')).storageVersion,
    getRevision: async ({area, revision} = {}) =>
      import(
        /* webpackMode: "eager" */ `storage/revisions/${area}/${revision}.js`
      )
  };

  await migrate(context, {area: 'local'});
}

init();

License

Copyright (c) 2021-2024 Armin Sebastian

This software is released under the terms of the MIT License. See the LICENSE file for further information.