event-source-polyfill 0.0.7 → 0.0.12

package/Gruntfile.js

@@ -10,8 +10,8 @@ module.exports = function(grunt) {
         }
       },
       build: {
-        src: 'eventsource.js',
-        dest: 'eventsource.min.js'
+        src: 'src/eventsource.js',
+        dest: 'src/eventsource.min.js'
       }
     }
   });

package/README.md

@@ -14,13 +14,34 @@ npm install event-source-polyfill
 bower install event-source-polyfill
 ```
 
-Just include `eventsource.js` or `eventsource.min.js` in your page to use the polyfill.
+Just include `src/eventsource.js` or `src/eventsource.min.js` in your page to use the polyfill.
 
 
+Ionic2/Angular2 Installation:
+-----------------------------
+
+Unless a typescript definition file is created for this polyfill, this is how you would use it in an Ionic2 project.  It should (in theory) be very similar in an Angular2 project.
+
+```
+npm install event-source-polyfill
+```
+
+Add to (or create) src/app/polyfills.ts (path is relative to where polyfills.ts is) :
+```
+import 'path/to/event-source-polyfill/src/eventsource.min.js'
+```
+
+Add anywhere you need access to EventSourcePolyfill class : 
+
+```
+declare var EventSourcePolyfill: any;
+```
+
 Browser support:
 ----------------
 
-* IE 8+, Firefox 3.5+, Chrome 3+, Safari 4+, Opera 12+
+* IE 10+, Firefox 3.5+, Chrome 3+, Safari 4+, Opera 12+
+* IE 8 - IE 9: XDomainRequest is used internally, which has some limitations (2KB padding is requried, no way to send cookies, no way to use client certificates)
 * It works on Mobile Safari, Opera Mobile, Chrome for Android, Firefox for Android
 * It does not work on: Android Browser(requires 4 KB padding), Opera Mini
 
@@ -28,7 +49,7 @@ Advantages:
 -----------
 
 * Simple server-side code
-* Cross-domain requests support ("withCredentials" is not supported in IE8-IE9)
+* Cross-domain requests support
 
 Server-side requirements:
 -------------------------
@@ -45,12 +66,22 @@ Specification:
 Build:
 ------
 
-* To build EventSource, just install npm modules (`npm install`) and then run the build (`npm run build`). It should generate a new version of eventsource.min.js.
+* To build EventSource, just install npm modules (`npm install`) and then run the build (`npm run build`). It should generate a new version of `src/eventsource.min.js`.
 
 Notes:
 -----
  * If you are using HTTP Basic Authentication, you can embed credentials into the URL - `http://username:password@github.com`.
 
+Custom Headers:
+---------------
+```
+var es = new EventSourcePolyfill('/events', {
+  headers: {
+    'X-Custom-Header': 'value'
+  }
+});
+```
+
 Other EventSource polyfills:
 ----------------------------
 
@@ -80,11 +111,12 @@ http.createServer(function (request, response) {
 
     response.writeHead(200, {
       "Content-Type": "text/event-stream",
-      "Cache-Control": "no-cache",
+      "Cache-Control": "no-store",
       "Access-Control-Allow-Origin": "*"
     });
 
-    response.write(":" + Array(2049).join(" ") + "\n"); // 2kB padding for IE
+    var padding = new Array(2049);
+    response.write(":" + padding.join(" ") + "\n"); // 2kB padding for IE
     response.write("retry: 2000\n");
 
     var lastEventId = Number(request.headers["last-event-id"]) || Number(parsedURL.query.lastEventId) || 0;
@@ -112,7 +144,7 @@ http.createServer(function (request, response) {
     if (pathname === "/") {
       pathname = "/index.html";
     }
-    if (pathname === "/index.html" || pathname === "../eventsource.js") {
+    if (pathname === "/index.html" || pathname === "../src/eventsource.js") {
       response.writeHead(200, {
         "Content-Type": pathname === "/index.html" ? "text/html" : "text/javascript"
       });
@@ -129,7 +161,7 @@ or use PHP (see php/events.php)
 <?php
 
   header("Content-Type: text/event-stream");
-  header("Cache-Control: no-cache");
+  header("Cache-Control: no-store");
   header("Access-Control-Allow-Origin: *");
 
   $lastEventId = floatval(isset($_SERVER["HTTP_LAST_EVENT_ID"]) ? $_SERVER["HTTP_LAST_EVENT_ID"] : 0);
@@ -163,7 +195,7 @@ index.html (php/index.html):
     <meta charset="utf-8" />
     <title>EventSource example</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <script src="../eventsource.js"></script>
+    <script src="../src/eventsource.js"></script>
     <script>
       var es = new EventSource("events.php");
       var listener = function (event) {

package/bower.json

@@ -1,5 +1,5 @@
 {
   "name": "event-source-polyfill",
-  "version": "0.0.7",
-  "main": "eventsource.js"
+  "version": "0.0.12",
+  "main": "src/eventsource.js"
 }

package/component.json

@@ -2,7 +2,7 @@
   "name": "event-source-polyfill",
   "repo": "yaffle/eventsource",
   "description": "a polyfill for http://www.w3.org/TR/eventsource/",
-  "version": "0.0.7",
+  "version": "0.0.12",
   "keywords": [
     "sse",
     "server sent events",
@@ -13,8 +13,8 @@
   "dependencies": {},
   "development": {},
   "license": "MIT",
-  "main": "eventsource.js",
+  "main": "src/eventsource.js",
   "scripts": [
-    "eventsource.js"
+    "src/eventsource.js"
   ]
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "event-source-polyfill",
-  "version": "0.0.7",
+  "version": "0.0.12",
   "description": "A polyfill for http://www.w3.org/TR/eventsource/ ",
-  "main": "eventsource.js",
+  "main": "src/eventsource.js",
   "scripts": {
     "build": "grunt"
   },

package/php/events.php

@@ -1,26 +1,26 @@
-<?php
-
-  header("Content-Type: text/event-stream");
-  header("Cache-Control: no-cache");
-  header("Access-Control-Allow-Origin: *");
-
-  $lastEventId = floatval(isset($_SERVER["HTTP_LAST_EVENT_ID"]) ? $_SERVER["HTTP_LAST_EVENT_ID"] : 0);
-  if ($lastEventId == 0) {
-    $lastEventId = floatval(isset($_GET["lastEventId"]) ? $_GET["lastEventId"] : 0);
-  }
-
-  echo ":" . str_repeat(" ", 2048) . "\n"; // 2 kB padding for IE
-  echo "retry: 2000\n";
-
-  // event-stream
-  $i = $lastEventId;
-  $c = $i + 100;
-  while (++$i < $c) {
-    echo "id: " . $i . "\n";
-    echo "data: " . $i . ";\n\n";
-    ob_flush();
-    flush();
-    sleep(1);
-  }
-
+<?php
+
+  header("Content-Type: text/event-stream");
+  header("Cache-Control: no-store");
+  header("Access-Control-Allow-Origin: *");
+
+  $lastEventId = floatval(isset($_SERVER["HTTP_LAST_EVENT_ID"]) ? $_SERVER["HTTP_LAST_EVENT_ID"] : 0);
+  if ($lastEventId == 0) {
+    $lastEventId = floatval(isset($_GET["lastEventId"]) ? $_GET["lastEventId"] : 0);
+  }
+
+  echo ":" . str_repeat(" ", 2048) . "\n"; // 2 kB padding for IE
+  echo "retry: 2000\n";
+
+  // event-stream
+  $i = $lastEventId;
+  $c = $i + 100;
+  while (++$i < $c) {
+    echo "id: " . $i . "\n";
+    echo "data: " . $i . ";\n\n";
+    ob_flush();
+    flush();
+    sleep(1);
+  }
+
 ?>

package/php/index.html

@@ -1,23 +1,23 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <meta charset="utf-8" />
-    <title>EventSource example</title>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <script src="../eventsource.js"></script>
-    <script>
-      var es = new EventSource("events.php");
-      var listener = function (event) {
-        var div = document.createElement("div");
-        var type = event.type;
-        div.appendChild(document.createTextNode(type + ": " + (type === "message" ? event.data : es.url)));
-        document.body.appendChild(div);
-      };
-      es.addEventListener("open", listener);
-      es.addEventListener("message", listener);
-      es.addEventListener("error", listener);
-    </script>
-</head>
-<body>
-</body>
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <title>EventSource example</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <script src="../src/eventsource.js"></script>
+    <script>
+      var es = new EventSource("events.php");
+      var listener = function (event) {
+        var div = document.createElement("div");
+        var type = event.type;
+        div.appendChild(document.createTextNode(type + ": " + (type === "message" ? event.data : es.url)));
+        document.body.appendChild(div);
+      };
+      es.addEventListener("open", listener);
+      es.addEventListener("message", listener);
+      es.addEventListener("error", listener);
+    </script>
+</head>
+<body>
+</body>
 </html>