Merge pull request #403 from marklogic/develop

Merge develop with 2.0.0-rc

Author: wooldridge

KERBEROS.md

@@ -1,6 +1,6 @@
 # Kerberos Authentication
 
-In addition to basic, digest, and certificate authentication, the Node.js Client API supports [Kerberos authentication](https://docs.marklogic.com/guide/security/external-auth) for MarkLogic servers that have been so configured.
+In addition to basic, digest, and certificate authentication, the Node.js Client API supports [Kerberos authentication](https://docs.marklogic.com/guide/security/external-auth) on MarkLogic servers.
 
 The Node.js Client API uses the [kerberos](https://www.npmjs.com/package/kerberos) module to support Kerberos authentication and requires (on Linux):
 
@@ -11,6 +11,6 @@ The Node.js Client API uses the [kerberos](https://www.npmjs.com/package/kerbero
 
 Windows requires additional libraries. See the [kerberos documentation](https://www.npmjs.com/package/kerberos) for details.
 
-The [kerberos](https://www.npmjs.com/package/kerberos) module is listed as an optional dependency in the Node Client API package.json. To skip installing optional modules during [npm install](https://docs.npmjs.com/cli/install), use the --no-optional flag:
+The [kerberos](https://www.npmjs.com/package/kerberos) module is listed as an optional dependency in the Node.js Client API package.json. To skip installing optional modules during [npm install](https://docs.npmjs.com/cli/install), use the --no-optional flag:
 
     npm install --no-optional

README.md

@@ -13,23 +13,6 @@ from Node.js applications.
 *  Extending the built-in services or evaluating or invoking your own JavaScript or XQuery on the server
 *  Basic, digest, certificate, and Kerberos authentication
 
-## Status
-
-Release 2.0.1 of the MarkLogic Node.js Client API, tested to work with MarkLogic
-versions 8.0-6.3 and 9.0-1. To use the new features available in release 2.0.1,
-you will need to run MarkLogic version 9.
-
-## New Features in Release 2.0.1
-
-- Certificate authentication
-- Kerberos authentication
-- Geospatial region search
-- Double precision values for geospatial queries
-- Temporal operations, including protect and wipe
-- Metadata values
-- Specifying a minimum distance for near queries
-- Bug fixes and documentation enhancements
-
 ## Getting Started
 
 You can install the marklogic package as a dependency for your Node.js project
@@ -67,21 +50,14 @@ db.createCollection(
   });
 ```
 
-Other calls can create additional documents for the same collection.
-
 ### Resources
 
-Here are some online resources that walk you through working with MarkLogic
-using the Node.js Client API:
-
-* [MarkLogic Node.js Client API](http://developer.marklogic.com/features/node-client-api)
-* [Introduction to the Node.js Client API - Getting Started](http://docs.marklogic.com/guide/node-dev/intro#id_68052)
-
-The instructions describe:
-
-* installing the MarkLogic database and setting up an admin user
-* installing the Node.js Client API using npm
-* working through some initial examples to get familiar with the API
+* [Node.js Client API Documentation](https://docs.marklogic.com/jsdoc/index.html)
+* [Feature Overview of the Node.js Client API](http://developer.marklogic.com/features/node-client-api)
+* [The Node.js Client API in 5 Minutes](https://developer.marklogic.com/learn/node-in-5-minutes)
+* [Node.js Application Developer's Guide](http://docs.marklogic.com/guide/node-dev)
+* [MarkLogic Training for the Node.js Client API](http://www.marklogic.com/training-courses/developing-marklogic-applications-i-node-js/)
+* [MarkLogic On-Demand Courses for Node.js](https://mlu.marklogic.com/ondemand/index.xqy?q=Series%3A%22Node.js%22)
 
 ### Code Examples
 
@@ -90,15 +66,16 @@ in the online resources. To run the examples, follow the instructions here:
 
     examples/1readme.txt
 
-### Generating Documentation
+### Generating Documentation Locally
 
-After installing the project dependencies (including the gulp build system),
-you can build the reference documentation locally from the root directory of the
-marklogic package:
+After installing the project dependencies (including the [gulp](http://gulpjs.com/) 
+build system), you can build the reference documentation locally from the root 
+directory of the marklogic package:
 
     gulp doc
 
-The documentation is generated in a doc subdirectory.
+The documentation is generated in a doc subdirectory. The documentation can also be
+accessed online [here](https://docs.marklogic.com/jsdoc/index.html).
 
 ### Running Tests
 

lib/patch-builder.js

@@ -22,7 +22,7 @@ var qb = require('./query-builder.js');
 
 /**
  * A helper for building the definition of a document patch. The helper is
- * created by the {@link module:marklogic.patchBuilder} function.
+ * created by the {@link marklogic.patchBuilder} function.
  * @namespace patchBuilder
  */
 

lib/query-builder.js

@@ -72,7 +72,7 @@ function addIndex(query, index, isContainer) {
 
 /**
  * A helper for building the definition of a document query. The helper is
- * created by the {@link module:marklogic.queryBuilder} function.
+ * created by the {@link marklogic.queryBuilder} function.
  * @namespace queryBuilder
  */
 
@@ -3871,7 +3871,7 @@ util.inherits(TrueQueryDef, QueryDef);
  * and the number of documents in the slice.  (A slice is also sometimes
  * called a page of search results.)
  * By default, the slice uses array slice mode, but you can switch
- * to legacy slice mode with {@link module:marklogic.setSliceMode}. Legacy
+ * to legacy slice mode with {@link marklogic.setSliceMode}. Legacy
  * slice mode is deprecated and will be removed in the next major release.
  * @method
  * @since 1.0

lib/values-builder.js

@@ -40,7 +40,7 @@ var qb     = require('./query-builder.js').builder;
 /**
  * A helper for building the definition of a values query, which projects
  * tuples (aka rows) of values out of documents. The helper is created by
- * the {@link module:marklogic.valuesBuilder} function. You must call
+ * the {@link marklogic.valuesBuilder} function. You must call
  * the {@link valuesBuilder#fromIndexes} function to supply the required
  * clause of the values query before calling the
  * {@link valuesBuilder.BuiltQuery#where},

package.json

@@ -3,7 +3,7 @@
   "name": "marklogic",
   "description": "The official MarkLogic Node.js client API.",
   "homepage": "http://github.com/marklogic/node-client-api",
-  "version": "2.0.0-ea4",
+  "version": "2.0.1",
   "license": "Apache-2.0",
   "main": "./lib/marklogic.js",
   "keywords": [

test-complete/nodejs-documents-transaction-timelimit.js

@@ -52,7 +52,7 @@ describe('Document transaction test', function() {
 */
   var tid = 0;
 it('should commit the write document', function(done) {
-    db.transactions.open({transactionName: "nodeTransaction", timeLimit: 1})
+    db.transactions.open({transactionName: "nodeTransaction", timeLimit: 2})
      .result(function(response) {
      tid = response.txid;
       return db.documents.write({
@@ -70,7 +70,7 @@ it('should commit the write document', function(done) {
       .then(function(response) {
       //console.log(JSON.stringify(response, null, 2));
      response['transaction-status']['transaction-name'].should.equal('nodeTransaction');
-      response['transaction-status']['time-limit'].should.equal('1');
+      response['transaction-status']['time-limit'].should.equal('2');
     done();
     }, done);
     /*.catch(function(error) {