Merge pull request #149 from gregolsky/v4.0

add readme examples for new features

Author: gregolsky

README.md

@@ -4,6 +4,13 @@
 
 ## Changelog
 
+### 4.0.3 - 2018-10-01
+Added support for the following features:
+- [Streaming](#streaming)
+- More like this
+- [Suggestions](#suggestions)
+- [Revisions](#revisions)
+
 ### 4.0.2 - 2018-09-14
 Added support for the following features:
 - [Attachments](#attachments)
@@ -666,6 +673,73 @@ queryStream.on("error", err => {
 
 ```
 
+### Revisions
+NOTE: Please make sure revisions are enabled before trying one of the below.
+
+```javascript
+const session = store.openSession();
+const user = {
+    name: "Marcin",
+    age: 30,
+    pet: "users/4"
+};
+
+await session.store(user, "users/1");
+await session.saveChanges();
+
+// modify doc to create a new revision
+user.name = "Roman";
+user.age = 40;
+await session.saveChanges();
+
+// get revisions
+const revisions = await session.advanced.revisions.getFor("users/1");
+// [ { name: 'Roman',
+//     age: 40,
+//     pet: 'users/4',
+//     '@metadata': [Object],
+//     id: 'users/1' },
+//   { name: 'Marcin',
+//     age: 30,
+//     pet: 'users/4',
+//     '@metadata': [Object],
+//     id: 'users/1' } ]
+```
+
+### Suggestions
+```javascript
+// Having data:
+// [ User {
+//     name: 'John',
+//     age: 30,
+//     registeredAt: 2017-11-10T23:00:00.000Z,
+//     kids: [Array],
+//     id: 'users/1-A' },
+//   User {
+//     name: 'Stefanie',
+//     age: 25,
+//     registeredAt: 2015-07-29T22:00:00.000Z,
+//     id: 'users/2-A' } ]
+
+// and a static index like:
+class UsersIndex extends AbstractIndexCreationTask {
+    constructor() {
+        super();
+        this.map = "from doc in docs.Users select new { doc.name }";
+        this.suggestion("name");
+    }
+}
+
+// ...
+
+const session = store.openSession();
+const suggestionQueryResult = await session.query({ collection: "users" })
+    .suggestUsing(x => x.byField("name", "Jon"))
+    .execute();
+// { name: { name: 'name', suggestions: [ 'john' ] } }
+```
+
+
 ## Using object literals for entities
 
 In order to comfortably use object literals as entities set function getting collection name based on the content of the object - `store.conventions.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ravendb",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "RavenDB client for Node.js",
   "files": [
     "dist/"

package.json

@@ -11,6 +11,7 @@ import {
     IDocumentSession,
     QueryStatistics,
     StreamQueryStatistics,
+    AbstractIndexCreationTask,
 } from "../../src";
 import { TypeUtil } from "../../src/Utility/TypeUtil";
 
@@ -360,6 +361,10 @@ describe("Readme query samples", function () {
                 // ...
             });
 
+            userStream.on("end", () => {
+                assert.ok(result.length);
+            });
+
             await new Promise((resolve, reject) => {
                 stream.finished(userStream, err => {
                     err ? reject(err) : resolve();
@@ -369,12 +374,14 @@ describe("Readme query samples", function () {
 
         it("can stream query and get stats", async () => {
             let stats: StreamQueryStatistics;
+            const items = [];
             query = session.query({ collection: "users" })
                 .whereGreaterThan("age", 29);
             const queryStream = await session.advanced.stream(query, _ => stats = _);
 
             queryStream.on("data", user => {
                 print(user);
+                items.push(user);
                 // ...
             });
 
@@ -386,6 +393,7 @@ describe("Readme query samples", function () {
             await new Promise((resolve, reject) => {
                 queryStream.on("end", () => {
                     try {
+                        assert.ok(items.length);
                         assert.ok(stats);
                         assert.strictEqual(stats.totalResults, 1);
                         assert.strictEqual(stats.indexName, "Auto/users/Byage");
@@ -399,6 +407,54 @@ describe("Readme query samples", function () {
             });
         });
 
+        it("can suggest", async () => {
+            class UsersIndex extends AbstractIndexCreationTask {
+                constructor() {
+                    super();
+                    this.map = "from doc in docs.Users select new { doc.name }";
+                    this.suggestion("name");
+                }
+            }
+
+            await store.executeIndex(new UsersIndex());
+            await testContext.waitForIndexing(store);
+
+            {
+                const session = store.openSession();
+                const suggestionQueryResult = await session.query({ indexName: "UsersIndex" })
+                    .suggestUsing(x => x.byField("name", "Jon"))
+                    .execute();
+                assert.strictEqual(suggestionQueryResult.name.suggestions.length, 1);
+            }
+        });
+
+    });
+
+    describe("with revisions set up", function() {
+
+        beforeEach(async () => testContext.setupRevisions(store, false, 5));
+
+        it("can get revisions", async () => {
+
+            const session = store.openSession();
+
+            const user = {
+                name: "Marcin",
+                age: 30,
+                pet: "users/4"
+            };
+
+            await session.store(user, "users/1");
+            await session.saveChanges();
+
+            user.name = "Roman";
+            user.age = 40;
+            await session.saveChanges();
+
+            const revisions = await session.advanced.revisions.getFor("users/1");
+            assert.strictEqual(revisions.length, 2);
+        });
+
     });
 
     async function prepareUserDataSet(store: IDocumentStore) {