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

porter-source

v1.0.23

Published

Messaging Library for Web Extensions

Downloads

31

Readme

porter_logo

npm i porter-source

Porter scales from a simple Web Extensions sendMessage replacement to an enterprise message and state synchronization system with full Typescript support.

  • Minimal size (< 8kb)
  • Utilities for managing ports, messages and senders.
  • Faster and less memory than message sending
  • Many scenarios available -- Sidepanel, Devtools, Popup, and of course Content Scripts

Examples: Coming soon.

First, create a Porter Source

Porter can be sourced anywhere, but the Service Worker usually makes the most sense.

// service worker environment
import { source } from 'porter-source'

const [post, setMessages, onConnect] = source();

// set up message handlers for incoming messages
setMessages({
    hello_porter: (message, agentMetadata) => {
        console.log('Hello porter heard with message: ', message);
        // messages come with some convenience info
        console.log(`Hello porter came from: ${agentMetadata.key}, frameId: ${agentMetadata.frameId}, tabId: ${agentMetadata.tabId} `);
    },
    foo: (message, {key}) => {
        // send back a message using the port from the message received
        post({action: 'bar'}, key)
    }
});
// Messages are in the format {action: string, payload: any}
const message = {action: 'hello-agent', payload: { value: 3 }}
// targets are in the format {context: PorterContext | string, location?: {AgentLocation}}
// where PorterContext is 
type PorterContext = {
    'ContentScript'
    'Devtools',
    'Sidepanel',
    'Unknown'
}
// Or you can call it whatever you want with a string.

// send a message to a particular frame
const target = {context: PorterContext.ContentScript, location: {index: 1, subIndex: 123}}
post(message, target);

// send a message to all content scripts
const target = {context: PorterContext.ContentScript}
post(message, target);

// send a message to all frames for a tab
const tabId = 123;
const target = {context: PorterContext.ContentScript, location: {index: tabId}}
post(message, target);

// Similarly can target other contexts:
const target = {context: PorterContext.Devtools}
post(message, target);

// Or when you receive a message, can respond back to that sender without needing to know the particulars:
setMessages({
    from_devtools: (message, {key}) => {
        post({'hello_back'}, key)
    },
});

Use Porter in your 'Agents', that is, your Content Scripts, Sidepanels, Devtools, Popups, etc.

import { connect } from 'porter-source'

const [post, setMessages] = new connect()

// Just like the source Porter, we set up any message listeners we may want.
setMessages({
    bar: (message, port) => {
        // woohoo
    }
});

// And send messages to the source
post({action: 'foo'});

// Or bypass the service worker and send a message directly to another target
post({action: 'foo'}, PorterContext.Devtools);

Async actions

Just make the onMessage handler function an async function, in either the agent or the source.

// Usual setup, except we can make individual message handlers async
porter.onMessage({
    bar: async (message, agentMetadata) => {
        // await myFunction() {}
    }
});

Structure of messages

Porter prescribes the following message format:

type Message = {
    action: string;
    payload: any;
}

so a message will look like:

const message = {action: 'message-name', payload: {/*any shape*/}}