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

tyfsm

v1.0.11

Published

simple and typesafe finite-state machines. Inspired by zustand and xstate.

Downloads

10

Readme

tyfsm (wip)

simple and typesafe finite-state machines. Inspired by zustand and xstate.

Background

I like automata-based programming. Certain problems are solved elegantly when modelled as finite-state machines, particularly those related to the logic of user interfaces. It's a great tool in a programmer's toolbox.

The most popular js/ts fsm library is XState. It's pretty good but verbose and difficult to learn, it's a big investment to drop in a team setting. Furthermore, type-safety in XState seems like an afterthought.

For me one of the biggest benefits of finite-state machines is that they enable you to make illegal states unrepresentable, and a large chunk of that is missing from xstate. So that's why I built this library

Features

tyfsm's state machines are centered around leveraging the type-narrowing features of Typescript's discriminated unions.

The core of the state machine is a discriminated union, where each state is a single variant of the union. This gives us neat type-safety narrowing features.

Example

You define your state machine in Typescript's type system:

type WebsocketMachine = StateMachine<
  // First define your states and the data each state carries
  {
    idle: {
      addr: string;
    };
    connecting: {
      socket: WebSocket;
      addr: string;
    };
    connected: {
      socket: WebSocket;
      addr: string;
    };
    error: {
      errorMessage: string;
    };
  },
  // Now define the valid transitions between states
  {
    idle: ["connecting"];
    connecting: ["error", "connected"];
    connected: ["idle", "error"];
    error: ["idle"];
  }
>;

// Write a utility to make selecting states easy
type State<K extends WebsocketMachine["allStates"]> = SelectStates<
  WebsocketMachine,
  K
>;

// Now define actions for the machine
type Actions = {
  // This action can only be called in the `idle` state and transitions
  // the machine into the `connecting` state
  connect: (state: State<"idle">) => State<"connecting">;

  // This action can only be called in the `connecting` or `connected` state and transitions
  // the machine into the `idle` state
  disconnect: (state: State<"connecting" | "connected">) => State<"idle">;
};

Once you've modelled your state machine, you can create a store in a similar way like in zustand:

// Create the initial state
const initial: State<"idle"> = {
  kind: "idle",
  addr: "ws://localhost:8302",
};

export const useWebsocketStore = create<WebsocketMachine, Actions>(
  initial,
  // Create the machine's actions:
  //
  // `get` is a function that returns the current state of the machine
  // `transition` is a function that transitions the machine, with the following parameters:
  //    * the current state
  //    * the next state
  //    * the data for the next state
  (get, transition) => ({
    connect(idleState) {
      const socket = new WebSocket(idleState.addr);

      socket.addEventListener("error", () => {
        // Get the current state of the machine, it is important to not use
        // `idleState` from the above scope because the state may have changed in
        // between the time the outer function returns and this callback runs.
        const currentState = get();
        if (currentState.kind === "connecting") {
          transition(currentState.kind, "error", {
            errorMessage: "Failed to connect",
          });
        }
      });

      socket.addEventListener("open", () => {
        // Same treatment as above
        const currentState = get();
        if (currentState.kind === "connecting") {
          transition(currentState.kind, "connected", {
            socket,
            addr: currentState.addr,
          });
        }
      });

      return transition(idleState.kind, "connecting", {
        socket,
        addr: idleState.addr,
      });
    },
    disconnect(state) {
      state.socket.close();
      return transition(state.kind, "idle", {
        addr: state.addr,
      });
    },
  })
);

Now you can use it in React:

const App = () => {
  const { state, actions } = useWebsocketStore();

  switch (state.kind) {
    case "idle": {
      return <button onClick={() => actions.connect(state)}>Connect</button>;
    }
    case "connecting": {
      return <p>Connecting...</p>;
    }
    case "connected": {
      return (
        <button onClick={() => actions.disconnect(state)}>Disconnect</button>
      );
    }
    case "error": {
      return <p>Something went wrong: {state.errorMessage}</p>;
    }
  }
};

Note that all the actions are type-safe. You can only call actions.connect(state) when state is in the idle state. Similarly, the errorMessage property is only available on the state object when the machine is in the error state.

todo

  • explore hierarchical designs
  • transaction functions for async actions so state doesn't unexpectedly change