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

@onsetsoftware/automerge-store

v0.15.0

Published

A simple wrapper around [Automerge](https://automerge.org/) documents, with Redux Dev Tools integration and experimental undo/redo support. It works with both vanilla Automerge docs and `DocHandle`s from [Automerge Repo](https://github.com/automerge/autom

Downloads

42

Readme

Automerge Store

A simple wrapper around Automerge documents, with Redux Dev Tools integration and experimental undo/redo support. It works with both vanilla Automerge docs and DocHandles from Automerge Repo.

Installation

npm install @onsetsoftware/automerge-store

Usage

Automerge Documents

import { AutomergeStore } from "@onsetsoftware/automerge-store";
import { from } from "@automerge/automerge";

type DocState = {
  count: number;
};

const doc = from({
  count: 0,
});

const docId = "documentId";

const store = new AutomergeStore(docId, doc);

Automerge Repo Handles

import { AutomergeRepoStore } from "@onsetsoftware/automerge-store";
import { DocHandle, DocumentId, Repo } from "@automerge/automerge-repo";
import { LocalForageStorageAdapter } from "@automerge/automerge-repo-storage-localforage";
import * as localforage from "localforage";

type DocState = {
  count: number;
};

const repo = new Repo({
  network: [],
  storage: new LocalForageStorageAdapter(),
});

const initialState: DocState = {
  count: 0,
};

// load a document from the repo, or create a new one
localforage.getItem("rootDocId").then(async (docId) => {
  let handle: DocHandle<DocState>;

  if (!docId) {
    // the doc doesn't exist, so create it, save the ID and then initialise it
    handle = repo.create<DocState>();
    localforage.setItem("rootDocId", handle.documentId);
    handle.change((doc) => {
      Object.assign(doc, initialState);
    });
  } else {
    handle = repo.find(docId as DocumentId);
  }

  const store = new AutomergeRepoStore(handle);
});

Subscribing

await store.ready();

const unsubscribe = store.subscribe((doc) => {
  // update your UI/update another state store
  console.log(doc);
});

// unsubscribe
unsubscribe();

Updating the document

// wait for the store to be ready before making changes
await store.ready();

store.change((doc) => {
  doc.count += 1;
});

Undo/Redo (Experimental)

Implementing Undo/Redo is not trivial, especially when it comes to handling network sync too. Currently undo patches are generated within a requestIdleCallback wrapper so that generating them does not block the renderer.

Undo/Redo is supported by the undo and redo methods:

store.undo();
store.redo();

You can also check if there are any undo/redo actions available:

store.canUndo();
store.canRedo();

Transactions

If you need to group a number of changes from different parts of your application into a single undo/redo action, you can use transactions:

store.transaction(() => {
  store.change((doc) => {
    doc.count += 1;
  });

  store.change((doc) => {
    doc.count += 1;
  });

  store.change((doc) => {
    doc.count += 1;
  });
});

console.log(store.doc.count); // 3

// undoing the transaction will undo all of the changes
store.undo(); // doc.count === 0

Transaction messages

You can also pass a message to the transaction, which will be passed to automerge as the change message and displayed in Redux Dev Tools. Either return a string from the transaction function, or pass it as the second argument:

store.transaction(
  () => {
    store.change((doc) => {
      doc.count += 1;
    });

    store.change((doc) => {
      doc.count += 1;
    });

    store.change((doc) => {
      doc.count += 1;
    });

    return "Incremented count";
  },
  // alternatively you can pass the message as the second argument. The return value will be used if both are provided
  "Incremented count"
);

Redux Dev Tools

Opt in to Redux Dev Tools support by passing the devTools option to the constructor:

const store = new AutomergeStore(docId, doc, {
  withDevTools: true,
});

For DevTools to work, the Redux Dev Tools browser extension needs to be installed and enabled. Time travel is fully functional, but persisting the state across page reloads is not yet supported.