Merge pull request #76 from ifwe/update-monocle-api

monocle api 2.0.0: Update dependencies, add typescript checks

Author: TysonAndre

.gitignore

@@ -4,3 +4,5 @@ test/coverage.html
 coverage/
 npm-debug.log
 .idea
+.*.swp
+.*.swo

.travis.yml

@@ -1,5 +1,7 @@
 language: node_js
 node_js:
-  - "5.11"
+  - "6"
+  - "8"
+  - "10"
 before_script:
   - npm install -g grunt-cli

Gruntfile.js

@@ -18,6 +18,18 @@ module.exports = function(grunt) {
             coverage: ['test/coverage.html']
         },
 
+        // https://www.npmjs.com/package/grunt-mocha-test
+        mochaTest: {
+            test: {
+                options: {
+                    reporter: 'spec',
+                    require: './test/test_runner',
+                    ui: 'bdd',
+                    timeout: 200
+                },
+                src: ['test/**/*_test.js']
+            }
+        },
         //Bump up version
         bump: {
             options: {
@@ -61,8 +73,10 @@ module.exports = function(grunt) {
     // Runs all unit tests
     grunt.registerTask('test', 'All unit tests', ['mochaTest:test']);
 
+    // TODO: Migrate this to https://www.npmjs.com/package/grunt-mocha-test#instrumenting-source-files-with-coverage-data-before-running-tests
     // Generates test coverage report
-    grunt.registerTask('coverage', 'Unit test code coverage', ['clean:coverage', 'mochaTest:instrument', 'mochaTest:coverage']);
+    // As a substitute, just use `npm test` instead
+    // grunt.registerTask('coverage', 'Unit test code coverage', ['clean:coverage', 'mochaTest:instrument', 'mochaTest:coverage']);
 
     // Generates documentation
     grunt.registerTask('docs', 'Generate documentation', ['clean:docs', 'docco:main']);

lib/CollectionCache.js

@@ -50,7 +50,8 @@ CollectionCache.prototype.id = function() {
     var props = [].concat(this.request.getProps()).sort();
 
     // 3. Gather all other query string parameters
-    var query = this.request.getUrl().search
+    // Note: In node 10, getUrl().search seems like it became optional?
+    var query = (this.request.getUrl().search || '')
     .replace(/^\?/, '')             // remove "?" from beginning of string
     .split('&')                     // create array of keyvalue parts
     .filter(function(keyvalue) {    // filter out "props" query string param
@@ -78,8 +79,8 @@ CollectionCache.prototype.id = function() {
 /**
  * Verifies an etag. Returns `true` if it matches.
  *
- * @param string etag - The etag to check.
- * @return boolean - True if passes validation.
+ * @param {string} etag - The etag to check.
+ * @returns {boolean} - True if passes validation.
  */
 CollectionCache.prototype.isValid = function(etag) {
     if (!etag) {

lib/Connection.js

@@ -27,7 +27,7 @@ function Connection(router, req, res) {
 ].forEach(function(method) {
     Connection.prototype[method.toLowerCase()] = function (resourceId, options) {
         debug('Incoming request', method, resourceId, options)
-        var request = new Request(resourceId, this.router, this);
+        var request = new Request(resourceId);
         request.setResourceId(resourceId);
         request.setMethod(method);
 

lib/CursorPaginator.js

@@ -1,7 +1,7 @@
 /**
  * A CursorPaginator represents an array of items
  * that can be paginated via offset/limit parameters.
- * The items may be Resources, Symlinks, primatives, or any combination.
+ * The items may be Resources, Symlinks, primitives, or any combination.
  * CursorPaginator provides a fluent interface to simplify their creation.
  *
  * ```js
@@ -45,9 +45,9 @@ var CursorPaginator = function(id, items, expires) {
 /**
  * Sets the resource ID for this collection.
  *
- * @param string|undefined - The new resource ID or `undefined` to remove it.
+ * @param {string|undefined} id - The new resource ID or `undefined` to remove it.
  * @throws Error - Provided resource ID is invalid.
- * @return this - Fluent interface.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setId = function(id) {
     var type = typeof id;
@@ -61,7 +61,7 @@ CursorPaginator.prototype.setId = function(id) {
 /**
  * Gets the resource ID, or undefined if not set.
  *
- * @return string|undefined - The resource ID for this collection
+ * @returns string|undefined - The resource ID for this collection
  */
 CursorPaginator.prototype.getId = function() {
     return this.$id;
@@ -70,10 +70,10 @@ CursorPaginator.prototype.getId = function() {
 /**
  * Sets the items in the collection.
  *
- * @param array items - Array of items that are in this collection.
- *     May be an array of Resources, Symlinks, primatives, or any combination.
+ * @param {Array} items - Array of items that are in this collection.
+ *     May be an array of Resources, Symlinks, primitives, or any combination.
  * @throws Error - When non-array is passed in.
- * @return this - Fluent interface.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setItems = function(items) {
     if (!Array.isArray(items)) {
@@ -86,7 +86,7 @@ CursorPaginator.prototype.setItems = function(items) {
 /**
  * Gets the items in the collection.
  *
- * @return array - All items in the collection.
+ * @returns array - All items in the collection.
  */
 CursorPaginator.prototype.getItems = function() {
     return this.items;
@@ -95,10 +95,10 @@ CursorPaginator.prototype.getItems = function() {
 /**
  * Sets the value for an item in the collection.
  *
- * @param integer position - The array position.
- * @param array item - Item to be placed into specified position.
+ * @param {Number} position - The integer array position.
+ * @param {Array} item - Item to be placed into specified position.
  * @throws Error - Invalid position.
- * @return this - Fluent interface.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setItem = function(position, item) {
     if (typeof position !== 'number') {
@@ -116,8 +116,8 @@ CursorPaginator.prototype.setItem = function(position, item) {
 /**
  * Returns the value for an item in the collection, or undefined if not set.
  *
- * @param integer position - The array position.
- * @return mixed - The item at the position in the collection or undefined.
+ * @param {Number} position - The integer array position.
+ * @returns mixed - The item at the position in the collection or undefined.
  */
 CursorPaginator.prototype.getItem = function(position) {
     return this.items[position];
@@ -126,9 +126,9 @@ CursorPaginator.prototype.getItem = function(position) {
 /**
  * Sets the expiration for the collection in milliseconds.
  *
- * @param integer|undefined - Maximum number of milliseconds this collection may be cached for.
+ * @param {Number|undefined} expires - Maximum number of milliseconds this collection may be cached for.
  * @throws Error - Expiration is invalid.
- * @return this - Fluent interface.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setExpires = function(expires) {
     var type = typeof expires;
@@ -148,7 +148,7 @@ CursorPaginator.prototype.setExpires = function(expires) {
 /**
  * Returns the expiration for the collection in milliseconds, or undefined if not set.
  *
- * @return integer|undefined - Maximum number of milliseconds this collection may be cached for.
+ * @returns integer|undefined - Maximum number of milliseconds this collection may be cached for.
  */
 CursorPaginator.prototype.getExpires = function() {
     return this.$expires;
@@ -158,9 +158,9 @@ CursorPaginator.prototype.getExpires = function() {
  * Sets the total number of items in the collection.
  * May be more than the number of items represented.
  *
- * @param integer total - Number of items in the collection.
+ * @param {Number} total - Number of items in the collection.
  * @throws Error - Total is invalid.
- * @return mixed - Total number of items in collection if no argument provided,
+ * @returns mixed - Total number of items in collection if no argument provided,
  *     otherwise returns `this` for fluent interface
  */
 CursorPaginator.prototype.setTotal = function(total) {
@@ -181,7 +181,7 @@ CursorPaginator.prototype.setTotal = function(total) {
 /**
  * Returns the total number of items in the collection, or undefined if not set.
  *
- * @return integer|undefined - Total number of items in the collection
+ * @returns integer|undefined - Total number of items in the collection
  */
 CursorPaginator.prototype.getTotal = function() {
     return this.total;
@@ -190,9 +190,9 @@ CursorPaginator.prototype.getTotal = function() {
 /**
  * Sets the limit of items in the collection, or undefined if no limit is set.
  *
- * @param integer|undefined limit - Limit of items in the collection.
+ * @param {Number|undefined} limit - Limit of items in the collection.
  * @throws Error - Limit is invalid.
- * @return this - Fluent interface.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setLimit = function(limit) {
     var type = typeof limit;
@@ -212,7 +212,7 @@ CursorPaginator.prototype.setLimit = function(limit) {
 /**
  * Returns the limit of items in the collection, or undefined if not set.
  *
- * @return integer|undefined - Limit of items in the collection.
+ * @returns integer|undefined - Limit of items in the collection.
  */
 CursorPaginator.prototype.getLimit = function() {
     return this.limit;
@@ -221,8 +221,8 @@ CursorPaginator.prototype.getLimit = function() {
 /**
  * Sets the current cursor for the items in the collection, or undefined if no cursor exists.
  *
- * @param string|undefined cursor - Current cursor for items in the collection.
- * @return this - Fluent interface.
+ * @param {String|undefined} cursor - Current cursor for items in the collection.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setCursor = function(cursor) {
     this.cursor = cursor;
@@ -232,7 +232,7 @@ CursorPaginator.prototype.setCursor = function(cursor) {
 /**
  * Returns the current cursor for the items in the collection, or undefined if no cursor exists.
  *
- * @return string|undefined - Current cursor for items in the collection.
+ * @returns string|undefined - Current cursor for items in the collection.
  */
 CursorPaginator.prototype.getCursor = function() {
     return this.cursor;
@@ -242,8 +242,8 @@ CursorPaginator.prototype.getCursor = function() {
 /**
  * Sets the cursor for the next page of items in the collection, or undefined if no next cursor exists.
  *
- * @param string|undefined nextCursor - Cursor for the next page of items in the collection.
- * @return this - Fluent interface.
+ * @param {String|undefined} nextCursor - Cursor for the next page of items in the collection.
+ * @returns this - Fluent interface.
  */
 CursorPaginator.prototype.setNextCursor = function(nextCursor) {
     this.nextCursor = nextCursor;
@@ -253,7 +253,7 @@ CursorPaginator.prototype.setNextCursor = function(nextCursor) {
 /**
  * Returns the cursor for the next page of items in the collection, or undefined if not set.
  *
- * @return string|undefined - Cursor for next page of items in the collection.
+ * @returns string|undefined - Cursor for next page of items in the collection.
  */
 CursorPaginator.prototype.getNextCursor = function() {
     return this.nextCursor;
@@ -262,7 +262,7 @@ CursorPaginator.prototype.getNextCursor = function() {
 /**
  * Removes the last item from the collection and returns it.
  *
- * @return mixed
+ * @returns any
  */
 CursorPaginator.prototype.pop = function() {
     return this.items.pop();
@@ -271,8 +271,8 @@ CursorPaginator.prototype.pop = function() {
 /**
  * Adds the item to the end of the collection.
  *
- * @param mixed item - The item to add
- * @return this - fluent interface
+ * @param {any} item - The item to add
+ * @returns {CursorPaginator} - fluent interface
  */
 CursorPaginator.prototype.push = function(item) {
     this.items.push(item);
@@ -282,7 +282,7 @@ CursorPaginator.prototype.push = function(item) {
 /**
  * Removes the first item from the collection and returns it.
  *
- * @return mixed
+ * @returns mixed
  */
 CursorPaginator.prototype.shift = function() {
     return this.items.shift();
@@ -291,8 +291,8 @@ CursorPaginator.prototype.shift = function() {
 /**
  * Adds the item to the beginning of the collection.
  *
- * @param mixed item - The item to add
- * @return this - fluent interface
+ * @param {any} item - The item to add
+ * @returns this - fluent interface
  */
 CursorPaginator.prototype.unshift = function(item) {
     this.items.unshift(item);

lib/OffsetPaginator.js

@@ -1,7 +1,7 @@
 /**
  * An OffsetPaginator represents an array of items
  * that can be paginated via offset/limit parameters.
- * The items may be Resources, Symlinks, primatives, or any combination.
+ * The items may be Resources, Symlinks, primitives, or any combination.
  * OffsetPaginator provides a fluent interface to simplify their creation.
  *
  * ```js
@@ -44,7 +44,7 @@ var OffsetPaginator = function(id, items, expires) {
 /**
  * Sets the resource ID for this collection.
  *
- * @param string|undefined - The new resource ID or `undefined` to remove it.
+ * @param {String|undefined} id - The new resource ID or `undefined` to remove it.
  * @throws Error - Provided resource ID is invalid.
  * @return this - Fluent interface.
  */
@@ -69,8 +69,8 @@ OffsetPaginator.prototype.getId = function() {
 /**
  * Sets the items in the collection.
  *
- * @param array items - Array of items that are in this collection.
- *     May be an array of Resources, Symlinks, primatives, or any combination.
+ * @param {Array} items - Array of items that are in this collection.
+ *     May be an array of Resources, Symlinks, primitives, or any combination.
  * @throws Error - When non-array is passed in.
  * @return this - Fluent interface.
  */
@@ -94,8 +94,8 @@ OffsetPaginator.prototype.getItems = function() {
 /**
  * Sets the value for an item in the collection.
  *
- * @param integer position - The array position.
- * @param array item - Item to be placed into specified position.
+ * @param {Number} position - The array position.
+ * @param {Array} item - Item to be placed into specified position.
  * @throws Error - Invalid position.
  * @return this - Fluent interface.
  */
@@ -115,7 +115,7 @@ OffsetPaginator.prototype.setItem = function(position, item) {
 /**
  * Returns the value for an item in the collection, or undefined if not set.
  *
- * @param integer position - The array position.
+ * @param {Number} position - The array position.
  * @return mixed - The item at the position in the collection or undefined.
  */
 OffsetPaginator.prototype.getItem = function(position) {
@@ -125,7 +125,7 @@ OffsetPaginator.prototype.getItem = function(position) {
 /**
  * Sets the expiration for the collection in milliseconds.
  *
- * @param integer|undefined - Maximum number of milliseconds this collection may be cached for.
+ * @param {Number|undefined} expires - Maximum number of milliseconds this collection may be cached for.
  * @throws Error - Expiration is invalid.
  * @return this - Fluent interface.
  */
@@ -157,7 +157,7 @@ OffsetPaginator.prototype.getExpires = function() {
  * Sets the total number of items in the collection.
  * May be more than the number of items represented.
  *
- * @param integer total - Number of items in the collection.
+ * @param {Number} total - Number of items in the collection.
  * @throws Error - Total is invalid.
  * @return mixed - Total number of items in collection if no argument provided,
  *     otherwise returns `this` for fluent interface
@@ -189,7 +189,7 @@ OffsetPaginator.prototype.getTotal = function() {
 /**
  * Sets the limit of items in the collection, or undefined if no limit is set.
  *
- * @param integer|undefined limit - Limit of items in the collection.
+ * @param {Number|undefined} limit - Limit of items in the collection.
  * @throws Error - Limit is invalid.
  * @return this - Fluent interface.
  */
@@ -220,7 +220,7 @@ OffsetPaginator.prototype.getLimit = function() {
 /**
  * Sets the offset of items in the collection, or undefined if no offset is set.
  *
- * @param integer|undefined offset - Offset of items in the collection.
+ * @param {Number|undefined} offset - Offset of items in the collection.
  * @throws Error - Offset is invalid.
  * @return this - Fluent interface.
  */
@@ -260,7 +260,7 @@ OffsetPaginator.prototype.pop = function() {
 /**
  * Adds the item to the end of the collection.
  *
- * @param mixed item - The item to add
+ * @param {any} item - The item to add
  * @return this - fluent interface
  */
 OffsetPaginator.prototype.push = function(item) {
@@ -280,7 +280,7 @@ OffsetPaginator.prototype.shift = function() {
 /**
  * Adds the item to the beginning of the collection.
  *
- * @param mixed item - The item to add
+ * @param {any} item - The item to add
  * @return this - fluent interface
  */
 OffsetPaginator.prototype.unshift = function(item) {