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

winchan

v0.2.2

Published

Here's the scenario: You want to build a secure means of some untrusted site opening a window, which loads content at a trusted site. Then you want the untrusted dude to be able to pass in parameters. Then you want the trusted code to do any amount of

Downloads

767,240

Readme

An abstraction for opening browser windows cross domain

Here's the scenario: You want to build a secure means of some untrusted site opening a window, which loads content at a trusted site. Then you want the untrusted dude to be able to pass in parameters. Then you want the trusted code to do any amount of stuff, and return a response.

This kinda thing is what lots of services on the web do, services like BrowserID.

Trouble is that this is stupidly hard:

  • Mobile Firefox doesn't like it when you open windows with window options
  • IE 8 & 9 don't even allow postMessage between opener and window
  • iOS 5 has some interesting optimizations that can bite you if not careful
  • you should tightly check origins to avoid classes of attacks
  • you probably will have to add stuff in the DOM, you should make sure you can clean this up and avoid introducing fragile code

WinChan is an abstraction to solve these problems and make it easy to open windows which take and return parameters and load content cross domain.

Browser Support

WinChan is expected to work on:

  • winxp - win7 on IE8 and IE9
  • windows, linux, osx - Chrome, Firefox, Opera, and Safari
  • Android's "native" browser - 2.1, 2.2, 2.3.4, 3.2 (and presumably newer)
  • Fennec on Android

Usage

For the site spawning the window, the "untrusted" or "client" code:

WinChan.open({
  url: "http://trusted.host/dialog.html",
  relay_url: "http://trusted.host/relay.html",
  window_features: "menubar=0,location=0,resizable=0,scrollbars=0,status=0,dialog=1,width=700,height=375",
  params: {
    these: "things",
    are: "input parameters"
  }
}, function(err, r) {
  // err is a string on failure, otherwise r is the response object
});

For the site providing the window, the "trusted" code:

WinChan.onOpen(function(origin, args, cb) {
  // origin is the scheme+host+port that cause window invocation,
  // it can be trusted

  // args are the untrusted arguments provided by the calling site

  // and cb you can call within the function, or synchronously later.
  // calling it indicated the window is done and can be closed.
  cb({
    "these things": "are the response"
  });
});

Finally, you'll notice that the trusted code needs to host 'relay.html' somewhere (required for IE support).

Running Examples

there's a little tiny webserver in-tree to let you run the examples. You'll need node.js and npm installed. Once you have these, just:

$ npm i
$ scripts/run_example.js

Now load http://127.0.0.1:8100/example (or the more complicated example which demonstrates navigation away and back in window at http://127.0.0.1:8100/complex_example

Running Unit Tests

node.js and npm are required to run the unit tests. Once installed

$ npm i
$ scripts/run_example.js

And open http://127.0.0.1:8100/test in your favorite web browser.

NOTE: You'll need to disable popup blocking for localhost to run tests!

Testing over the network

the run_example.js script will bind whatever IP is in the IP_ADDRESS env var. So to test over the network:

$ npm i
$ IP_ADDRESS=<my external IP> scripts/run_example.js

(repace <my external IP> with your IP address)

then hit http://<my external IP>:8100/test