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

postmessage-communicator

v5.0.0

Published

[![Release](https://img.shields.io/github/v/release/wayfair-incubator/oss-template?display_name=tag)](CHANGELOG.md) [![Lint](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/wayfair-in

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

wayfairwayfair

Keywords

iframepostmessagecommunicator

Readme

postmessage-communicator

Release Lint Contributor Covenant Maintainer

About The Project

Use this tool to communicate across an iframe using postmessage subscription.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • yarn

    npm install --global yarn

Installation

  1. Clone the repo

    git clone https://github.com/wayfair-incubator/postmessage-communicator.git

  2. Install yarn packages and compile typescript code

    yarn
yarn tsc

Communicator API

subscribe

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ------------------------ | ------------------------- | ------- | | eventType | yes | event type to listen for | string | | | cb | yes | callback fired on event | (e: MessageEvent) => void | |

unsubscribe

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | --------------------------------- | ------------------------- | ------- | | cb | yes | callback returned as subscription | (e: MessageEvent) => void | |

post

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ---------------------------------- | ------------------------------------ | ------- | | type | yes | event type to post eg: addToCart | string | VendorEvent | ClientEvent | | | payload | yes | post data | anything but a function | |

Vendor Communicator API

addToCart

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ---------------------- | ------ | --------- | | customerUid | yes | customer identifier | string | | | projectId | yes | project identifier | string | | | projectVersion | no | project version | string | | | brand | yes | brand description | string | | | style | yes | style description | string | | | color | yes | color | string | | | url | yes | thumbnail image url | string | | | bom | yes | bill of materials | string | |

designerHandOff

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ---------------------- | ------ | --------- | | customerUid | yes | customer identifier | string | | | projectId | yes | project identifier | string | | | projectVersion | no | project version | string | | | brand | yes | brand description | string | | | style | yes | style description | string | | | color | yes | color | string | | | url | yes | thumbnail image url | string | | | area | yes | area of room | number | |

requestToken

no parameters

projectDirty

no parameters

projectSaved

no parameters

projectDeleted

no parameters

continueToCart

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ---------------------- | ------ | --------- | | customerUid | yes | customer identifier | string | | | projectId | yes | project identifier | string | | | projectVersion | no | project version | string | | | brand | yes | brand description | string | | | style | yes | style description | string | | | color | yes | color | string | | | url | yes | thumbnail image url | string | | | bom | yes | bill of materials | string | |

Client Communicator API

init

| Parameter Name | Required | Description | Type | Default | | ----------------- | -------- | -------------------------------------- | ------ | ------- | | token | yes | JWT token with initialization payload | string | | | landingExperience | yes | requested landing page for application | string | |

refreshToken

| Parameter Name | Required | Description | Type | Default | | -------------- | -------- | ------------------------------------- | ------ | ------- | | token | yes | JWT token with initialization payload | string | |

addToCartStatus

| Parameter Name | Required | Description | Type | Default | | ----------------- | -------- | -------------------------------------------------------- | ------ | ------- | | success | yes | flag indicating if the add to cart event succeded or not | boolean| | | message | yes | status message | string | | | projectId | yes | project id | string | | | versionId | yes | project version | string | |

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/wayfair-incubator/postmessage-communicator

Acknowledgements

This template was adapted from https://github.com/othneildrew/Best-README-Template.