js-cookie 2.1.1 → 2.2.0

package/README.md

@@ -1,4 +1,8 @@
-# JavaScript Cookie [![Build Status](https://travis-ci.org/js-cookie/js-cookie.svg?branch=master)](https://travis-ci.org/js-cookie/js-cookie) [![Code Climate](https://codeclimate.com/github/js-cookie/js-cookie.svg)](https://codeclimate.com/github/js-cookie/js-cookie)
+<p align="center">
+  <img src="https://cloud.githubusercontent.com/assets/835857/14581711/ba623018-0436-11e6-8fce-d2ccd4d379c9.gif">
+</p>
+
+# JavaScript Cookie [![Build Status](https://travis-ci.org/js-cookie/js-cookie.svg?branch=master)](https://travis-ci.org/js-cookie/js-cookie) [![Code Climate](https://codeclimate.com/github/js-cookie/js-cookie.svg)](https://codeclimate.com/github/js-cookie/js-cookie) [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/js-cookie/badge?style=rounded)](https://www.jsdelivr.com/package/npm/js-cookie)
 
 A simple, lightweight JavaScript API for handling cookies
 
@@ -9,12 +13,12 @@ A simple, lightweight JavaScript API for handling cookies
 * [Unobtrusive](#json) JSON support
 * Supports AMD/CommonJS
 * [RFC 6265](https://tools.ietf.org/html/rfc6265) compliant
-* Very good [Wiki](https://github.com/js-cookie/js-cookie/wiki)
+* Useful [Wiki](https://github.com/js-cookie/js-cookie/wiki)
 * Enable [custom encoding/decoding](#converters)
-* **~800 bytes** gzipped!
+* **~900 bytes** gzipped!
 
 **If you're viewing this at https://github.com/js-cookie/js-cookie, you're reading the documentation for the master branch.
-[View documentation for the latest release (2.1.1).](https://github.com/js-cookie/js-cookie/tree/v2.1.1#readme)**
+[View documentation for the latest release.](https://github.com/js-cookie/js-cookie/tree/latest#readme)**
 
 ## Build Status Matrix
 
@@ -22,18 +26,30 @@ A simple, lightweight JavaScript API for handling cookies
 
 ## Installation
 
-Include the script (unless you are packaging scripts somehow else):
+### Direct download
+
+Download the script [here](https://github.com/js-cookie/js-cookie/blob/latest/src/js.cookie.js) and include it (unless you are packaging scripts somehow else):
 
 ```html
 <script src="/path/to/js.cookie.js"></script>
 ```
 
+Or include it via [jsDelivr CDN](https://www.jsdelivr.com/package/npm/js-cookie):
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/js-cookie@2/src/js.cookie.min.js"></script>
+```
+
 **Do not include the script directly from GitHub (http://raw.github.com/...).** The file is being served as text/plain and as such being blocked
 in Internet Explorer on Windows 7 for instance (because of the wrong MIME type). Bottom line: GitHub is not a CDN.
 
-js-cookie supports [npm](https://www.npmjs.com/package/js-cookie) and [Bower](http://bower.io/search/?q=js-cookie) under the name `js-cookie`
+### Package Managers
+
+JavaScript Cookie supports [npm](https://www.npmjs.com/package/js-cookie) and [Bower](http://bower.io/search/?q=js-cookie) under the name `js-cookie`.
 
-It can also be loaded as an AMD or CommonJS module.
+### Module Loaders
+
+JavaScript Cookie can also be loaded as an AMD, CommonJS or [ES6](https://github.com/js-cookie/js-cookie/issues/233#issuecomment-233187386) module.
 
 ## Basic Usage
 
@@ -82,7 +98,9 @@ Cookies.remove('name'); // fail!
 Cookies.remove('name', { path: '' }); // removed!
 ```
 
-*IMPORTANT! when deleting a cookie, you must pass the exact same path, domain and secure attributes that were used to set the cookie, unless you're relying on the [default attributes](#cookie-attributes).*
+*IMPORTANT! when deleting a cookie, you must pass the exact same path and domain attributes that was used to set the cookie, unless you're relying on the [default attributes](#cookie-attributes).*
+
+*Note: Removing unexisting cookie does not raise any exception nor return any value*
 
 ## Namespace conflicts
 
@@ -132,7 +150,7 @@ Cookies.getJSON(); // => { name: { foo: 'bar' } }
 
 This project is [RFC 6265](http://tools.ietf.org/html/rfc6265#section-4.1.1) compliant. All special characters that are not allowed in the cookie-name or cookie-value are encoded with each one's UTF-8 Hex equivalent using [percent-encoding](http://en.wikipedia.org/wiki/Percent-encoding).  
 The only character in cookie-name or cookie-value that is allowed and still encoded is the percent `%` character, it is escaped in order to interpret percent input as literal.  
-To override the default cookie decoding you need to use a [converter](#converter).
+Please note that the default encoding/decoding strategy is meant to be interoperable [only between cookies that are read/written by js-cookie](https://github.com/js-cookie/js-cookie/pull/200#discussion_r63270778). To override the default encoding/decoding strategy you need to use a [converter](#converters).
 
 ## Cookie Attributes
 
@@ -142,6 +160,8 @@ Cookie attributes defaults can be set globally by setting properties of the `Coo
 
 Define when the cookie will be removed. Value can be a [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) which will be interpreted as days from time of creation or a [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance. If omitted, the cookie becomes a session cookie.
 
+To create a cookie that expires in less than a day, you can check the [FAQ on the Wiki](https://github.com/js-cookie/js-cookie/wiki/Frequently-Asked-Questions#expire-cookies-in-less-than-a-day).
+
 **Default:** Cookie is removed when the user closes the browser.
 
 **Examples:**
@@ -210,7 +230,7 @@ Either `true` or `false`, indicating if the cookie transmission requires a secur
 ```javascript
 Cookies.set('name', 'value', { secure: true });
 Cookies.get('name'); // => 'value'
-Cookies.remove('name', { secure: true });
+Cookies.remove('name');
 ```
 
 ## Converters
@@ -259,15 +279,22 @@ Check out the [Servers Docs](SERVER_SIDE.md)
 
 Check out the [Contributing Guidelines](CONTRIBUTING.md)
 
+## Security
+
+For vulnerability reports, send an e-mail to `jscookieproject at gmail dot com`
+
 ## Manual release steps
 
 * Increment the "version" attribute of `package.json`
 * Increment the version number in the `src/js.cookie.js` file
+* If `major` bump, update jsDelivr CDN major version link on README
 * Commit with the message "Release version x.x.x"
 * Create version tag in git
 * Create a github release and upload the minified file
-* Link the documentation of the latest release tag in the `README.md`
-* Commit with the message "Prepare for the next development iteration"
+* Change the `latest` tag pointer to the latest commit
+  * `git tag -f latest`
+  * `git push <remote> :refs/tags/latest`
+  * `git push origin master --tags`
 * Release on npm
 
 ## Authors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-cookie",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "A simple, lightweight JavaScript API for handling cookies",
   "main": "src/js.cookie.js",
   "directories": {
@@ -24,21 +24,26 @@
     "type": "git",
     "url": "git://github.com/js-cookie/js-cookie.git"
   },
+  "files": [
+    "src/**/*.js",
+    "SERVER_SIDE.md",
+    "CONTRIBUTING.md"
+  ],
   "author": "Klaus Hartl",
   "license": "MIT",
   "devDependencies": {
-    "grunt": "1.0.0",
-    "grunt-compare-size": "0.4.0",
-    "grunt-contrib-connect": "1.0.0",
-    "grunt-contrib-jshint": "1.0.0",
-    "grunt-contrib-nodeunit": "0.4.1",
-    "grunt-contrib-qunit": "1.1.0",
-    "grunt-contrib-uglify": "1.0.1",
+    "grunt": "1.0.1",
+    "grunt-compare-size": "0.4.2",
+    "grunt-contrib-connect": "1.0.2",
+    "grunt-contrib-jshint": "1.1.0",
+    "grunt-contrib-nodeunit": "1.0.0",
+    "grunt-contrib-qunit": "2.0.0",
+    "grunt-contrib-uglify": "2.3.0",
     "grunt-contrib-watch": "1.0.0",
-    "grunt-jscs": "2.8.0",
-    "grunt-saucelabs": "8.6.2",
+    "grunt-jscs": "3.0.1",
+    "grunt-saucelabs": "9.0.0",
     "gzip-js": "0.3.2",
-    "qunitjs": "1.23.0",
-    "requirejs": "2.2.0"
+    "qunitjs": "1.23.1",
+    "requirejs": "2.3.5"
   }
 }

package/src/js.cookie.js

@@ -1,16 +1,21 @@
 /*!
- * JavaScript Cookie v2.1.1
+ * JavaScript Cookie v2.2.0
  * https://github.com/js-cookie/js-cookie
  *
  * Copyright 2006, 2015 Klaus Hartl & Fagner Brack
  * Released under the MIT license
  */
 ;(function (factory) {
+	var registeredInModuleLoader = false;
 	if (typeof define === 'function' && define.amd) {
 		define(factory);
-	} else if (typeof exports === 'object') {
+		registeredInModuleLoader = true;
+	}
+	if (typeof exports === 'object') {
 		module.exports = factory();
-	} else {
+		registeredInModuleLoader = true;
+	}
+	if (!registeredInModuleLoader) {
 		var OldCookies = window.Cookies;
 		var api = window.Cookies = factory();
 		api.noConflict = function () {
@@ -51,6 +56,9 @@
 					attributes.expires = expires;
 				}
 
+				// We're using "expires" because "max-age" is not supported by IE
+				attributes.expires = attributes.expires ? attributes.expires.toUTCString() : '';
+
 				try {
 					result = JSON.stringify(value);
 					if (/^[\{\[]/.test(result)) {
@@ -69,13 +77,19 @@
 				key = key.replace(/%(23|24|26|2B|5E|60|7C)/g, decodeURIComponent);
 				key = key.replace(/[\(\)]/g, escape);
 
-				return (document.cookie = [
-					key, '=', value,
-					attributes.expires && '; expires=' + attributes.expires.toUTCString(), // use expires attribute, max-age is not supported by IE
-					attributes.path    && '; path=' + attributes.path,
-					attributes.domain  && '; domain=' + attributes.domain,
-					attributes.secure ? '; secure' : ''
-				].join(''));
+				var stringifiedAttributes = '';
+
+				for (var attributeName in attributes) {
+					if (!attributes[attributeName]) {
+						continue;
+					}
+					stringifiedAttributes += '; ' + attributeName;
+					if (attributes[attributeName] === true) {
+						continue;
+					}
+					stringifiedAttributes += '=' + attributes[attributeName];
+				}
+				return (document.cookie = key + '=' + value + stringifiedAttributes);
 			}
 
 			// Read
@@ -93,14 +107,14 @@
 
 			for (; i < cookies.length; i++) {
 				var parts = cookies[i].split('=');
-				var name = parts[0].replace(rdecode, decodeURIComponent);
 				var cookie = parts.slice(1).join('=');
 
-				if (cookie.charAt(0) === '"') {
+				if (!this.json && cookie.charAt(0) === '"') {
 					cookie = cookie.slice(1, -1);
 				}
 
 				try {
+					var name = parts[0].replace(rdecode, decodeURIComponent);
 					cookie = converter.read ?
 						converter.read(cookie, name) : converter(cookie, name) ||
 						cookie.replace(rdecode, decodeURIComponent);
@@ -127,7 +141,7 @@
 
 		api.set = api;
 		api.get = function (key) {
-			return api(key);
+			return api.call(api, key);
 		};
 		api.getJSON = function () {
 			return api.apply({

package/.jshintignore

@@ -1,2 +0,0 @@
-build
-node_modules

package/.jshintrc

@@ -1,14 +0,0 @@
-{
-	"curly": true,
-	"eqeqeq": true,
-	"expr": true,
-	"newcap": true,
-	"noarg": true,
-	"nonbsp": true,
-	"trailing": true,
-	"undef": true,
-	"unused": true,
-	"globals": {
-		"Cookies": true
-	}
-}

package/.npmignore

@@ -1,4 +0,0 @@
-node_modules
-build
-.sizecache.json
-*.log*

package/.tm_properties

@@ -1,11 +0,0 @@
-softTabs = false
-tabSize  = 2
-
-[ text.plain ]
-softWrap   = true
-wrapColumn = "Use Window Frame"
-softTabs   = true
-tabSize    = 4
-
-[ "*.md" ]
-fileType = "text.plain"

package/.travis.yml

@@ -1,12 +0,0 @@
-language: node_js
-node_js:
-  - '5.1.1'
-# Only use grunt-ci for commits pushed to this repo. Fall back to regular test
-# for pull requests (as secure variables won't be exposed there).
-script:
-  - ./travis.sh
-env:
-  # Encrypted SAUCE_USERNAME and SAUCE_ACCESS_KEY used by travis
-  global:
-    - secure: IkMOa/8r4sWyzUMxecsfqoPzZyIqVAMwPkQ6/HxXPbT8X7UnvqAdaicAMeHEKtOnOac+rx6pGB9HQvC8P/ZzkEBtsKLP4nEh9vsAInZvb3pXg+qbIgIK6/19X0kU4UkpDqVdWmBuFTamJvMDMstUTgEaM3869bB5vGp9taBgfVo=
-    - secure: DKrQplF0CBiBh+cbQ8D7EKebCeklUWEELblIJdU4475Occ4G9b8ZFYO9HFwl1B8F/XapB7CsMyxbJCWor030FySeqn8bhJs9NoAVoYGg+MtWniv1EOHuZLWuOGfgQDv7qj5U0Af9Y655MmUpXSN2aDlCmQweWnYdpFTM9Dfsdd8=

package/Gruntfile.js

@@ -1,243 +0,0 @@
-/*jshint node:true */
-'use strict';
-
-module.exports = function (grunt) {
-
-	function encodingMiddleware(request, response, next) {
-		var url = require('url').parse(request.url, true, true);
-		var query = url.query;
-		var pathname = url.pathname;
-
-		if (pathname !== '/encoding') {
-			next();
-			return;
-		}
-
-		var cookieName = query.name;
-		var cookieValue = query.value;
-
-		response.setHeader('content-type', 'application/json');
-		response.end(JSON.stringify({
-			name: cookieName,
-			value: cookieValue
-		}));
-	}
-
-	grunt.initConfig({
-		pkg: grunt.file.readJSON('package.json'),
-		qunit: {
-			all: {
-				options: {
-					urls: [
-						'http://127.0.0.1:9998/',
-						'http://127.0.0.1:9998/amd.html',
-						'http://127.0.0.1:9998/encoding.html?integration_baseurl=http://127.0.0.1:9998/'
-					]
-				}
-			},
-		},
-		nodeunit: {
-			all: 'test/node.js'
-		},
-		jshint: {
-			options: {
-				jshintrc: true
-			},
-			grunt: 'Gruntfile.js',
-			source: 'src/**/*.js',
-			tests: ['test/**/*.js', '!test/polyfill.js']
-		},
-		jscs: {
-			options: {
-				requireCommaBeforeLineBreak: true,
-				requireLineFeedAtFileEnd: true,
-				requireSemicolons: true,
-				requireSpaceBeforeKeywords: ['else', 'while', 'catch'],
-				requireSpaceAfterKeywords: true,
-				requireSpaceAfterLineComment: true,
-				requireSpaceBeforeBlockStatements: true,
-				requireSpaceBeforeObjectValues: true,
-				validateIndentation: '\t',
-				validateLineBreaks: 'LF',
-				validateQuoteMarks: true,
-				disallowSpacesInsideArrayBrackets: 'all',
-				disallowSpacesInsideParentheses: true,
-				disallowTrailingWhitespace: true
-			},
-			grunt: 'Gruntfile.js',
-			source: 'src/**/*.js',
-			tests: ['test/**/*.js', '!test/polyfill.js']
-		},
-		uglify: {
-			options: {
-				banner: '/*! <%= pkg.name %> v<%= pkg.version %> | <%= pkg.license %> */\n'
-			},
-			build: {
-				files: {
-					'build/js.cookie-<%= pkg.version %>.min.js': 'src/js.cookie.js'
-				}
-			}
-		},
-		watch: {
-			options: {
-				livereload: true
-			},
-			files: '{src,test}/**/*.js',
-			tasks: 'default'
-		},
-		compare_size: {
-			files: [
-				'build/js.cookie-<%= pkg.version %>.min.js',
-				'src/js.cookie.js'
-			],
-			options: {
-				compress: {
-					gz: function (fileContents) {
-						return require('gzip-js').zip(fileContents, {}).length;
-					}
-				}
-			}
-		},
-		connect: {
-			'build-qunit': {
-				options: {
-					port: 9998,
-					base: ['.', 'test'],
-					middleware: function (connect, options, middlewares) {
-						middlewares.unshift(encodingMiddleware);
-						return middlewares;
-					}
-				}
-			},
-			'build-sauce': {
-				options: {
-					port: 9999,
-					base: ['.', 'test']
-				}
-			},
-			tests: {
-				options: {
-					port: 10000,
-					base: ['.', 'test'],
-					open: 'http://127.0.0.1:10000',
-					keepalive: true,
-					livereload: true,
-					middleware: function (connect, options, middlewares) {
-						middlewares.unshift(encodingMiddleware);
-						return middlewares;
-					}
-				}
-			}
-		},
-		'saucelabs-qunit': {
-			all: {
-				options: {
-					urls: ['http://127.0.0.1:9999'],
-					testname: 'Sauce Test for js-cookie',
-					build: process.env.TRAVIS_JOB_ID,
-					pollInterval: 10000,
-					statusCheckAttempts: 90,
-					throttled: 3,
-					browsers: (function () {
-						var browsers = {
-							'iOS': [{
-								browserName: 'iphone',
-								platform: 'OS X 10.10',
-								version: '8.2',
-								deviceName: 'iPhone Simulator'
-							}, {
-								browserName: 'iphone',
-								platform: 'OS X 10.10',
-								version: '8.2',
-								deviceName: 'iPad Simulator'
-							}],
-							'android': [{
-								browserName: 'android',
-								platform: 'Linux',
-								version: '5.1',
-								deviceName: 'Android Emulator'
-							}],
-							'mac': [{
-								browserName: 'safari',
-								platform: 'OS X 10.10',
-								version: '8.0'
-							}, {
-								browserName: 'firefox',
-								platform: 'OS X 10.10',
-								version: '36.0'
-							}, {
-								browserName: 'chrome',
-								platform: 'OS X 10.10',
-								versiono: '41.0'
-							}],
-							'windows7': [{
-								browserName: 'internet explorer',
-								platform: 'Windows 7',
-								version: '11.0'
-							}, {
-								browserName: 'internet explorer',
-								platform: 'Windows 7',
-								version: '10.0'
-							}, {
-								browserName: 'internet explorer',
-								platform: 'Windows 7',
-								version: '9.0'
-							}, {
-								browserName: 'opera',
-								platform: 'Windows 7',
-								version: '12.12'
-							}],
-							'windowsXP': [{
-								browserName: 'internet explorer',
-								platform: 'Windows XP',
-								version: '8.0'
-							}, {
-								browserName: 'internet explorer',
-								platform: 'Windows XP',
-								version: '7.0'
-							}, {
-								browserName: 'internet explorer',
-								platform: 'Windows XP',
-								version: '6.0'
-							}],
-							'linux': [{
-								browserName: 'opera',
-								platform: 'Linux',
-								version: '12.15'
-							}, {
-								browserName: 'firefox',
-								platform: 'Linux',
-								version: '37.0'
-							}, {
-								browserName: 'chrome',
-								platform: 'Linux',
-								version: '41.0'
-							}]
-						};
-
-						var matrix = [];
-						for (var os in browsers) {
-							matrix = matrix.concat(browsers[os]);
-						}
-						return matrix;
-					}())
-				}
-			}
-		}
-	});
-
-	// Loading dependencies
-	for (var key in grunt.file.readJSON('package.json').devDependencies) {
-		if (key !== 'grunt' && key.indexOf('grunt') === 0) {
-			grunt.loadNpmTasks(key);
-		}
-	}
-
-	grunt.registerTask('saucelabs', ['connect:build-sauce', 'saucelabs-qunit']);
-	grunt.registerTask('test', ['jshint', 'jscs', 'connect:build-qunit', 'qunit', 'nodeunit']);
-
-	grunt.registerTask('dev', ['test', 'uglify', 'compare_size']);
-	grunt.registerTask('ci', ['test', 'saucelabs']);
-
-	grunt.registerTask('default', 'dev');
-};

package/bower.json

@@ -1,18 +0,0 @@
-{
-  "name": "js-cookie",
-  "license": "MIT",
-  "main": [
-    "src/js.cookie.js"
-  ],
-  "ignore": [
-    "travis.sh",
-    "test",
-    "Gruntfile.js",
-    "package.json",
-    ".gitignore",
-    ".jshintignore",
-    ".jshintrc",
-    ".tm_properties",
-    ".travis.yml"
-  ]
-}

package/src/.jshintrc

@@ -1,13 +0,0 @@
-{
-	"browser": true,
-	"camelcase": true,
-	"quotmark": "single",
-	"globals": {
-		"define": true,
-		"module": true,
-		"require": true,
-		"escape": true
-	},
-
-	"extends": "../.jshintrc"
-}

package/test/.jshintrc

@@ -1,16 +0,0 @@
-{
-	"browser": true,
-	"qunit": true,
-
-	"-W053": true,
-
-	"extends": "../.jshintrc",
-	"globals": {
-		"require": true,
-		"unescape": true,
-		"lifecycle": true,
-		"using": true,
-		"addEvent": true,
-	  	"loadFileSync": true
-	}
-}

package/test/amd-config.js

@@ -1,9 +0,0 @@
-/*jshint unused:false */
-
-var require = {
-	paths: {
-		'qunit': [
-			'../node_modules/qunitjs/qunit/qunit'
-		]
-	}
-};

package/test/amd.html

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-		<meta charset="utf-8">
-		<title>JavaScript Cookie Test Suite - AMD</title>
-		<link href="../node_modules/qunitjs/qunit/qunit.css" rel="stylesheet">
-		<script src="amd-config.js"></script>
-		<script src="../node_modules/requirejs/require.js"></script>
-		<script src="amd.js"></script>
-	</head>
-	<body>
-		<div id="qunit"></div>
-		<div id="qunit-fixture"></div>
-	</body>
-</html>

package/test/amd.js

@@ -1,14 +0,0 @@
-require(['qunit'], function (QUnit) {
-	QUnit.module('amd');
-
-	QUnit.start();
-	QUnit.test('module loading', function (assert) {
-		QUnit.expect(1);
-		var done = assert.async();
-		require(['/src/js.cookie.js'], function (Cookies) {
-			assert.ok(!!Cookies.get, 'should load the api');
-			done();
-		});
-	});
-
-});

package/test/encoding.html

@@ -1,18 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-		<meta charset="utf-8">
-		<title>JavaScript Cookie Test Suite - Encoding</title>
-		<link href="../node_modules/qunitjs/qunit/qunit.css" rel="stylesheet">
-		<script src="../node_modules/qunitjs/qunit/qunit.js"></script>
-		<script src="../src/js.cookie.js"></script>
-		<script src="utils.js"></script>
-		<script src="encoding.js"></script>
-	</head>
-	<body>
-		<div id="qunit"></div>
-		<div id="qunit-fixture">
-			<iframe id="request_target"></iframe>
-		</div>
-	</body>
-</html>