Merge pull request #152 from gregolsky/v4.0

patch serialization fixes; exports tweaks

Author: gregolsky

.travis.yml

@@ -30,4 +30,6 @@ before_install:
   - pwd && ls
 script:
   - npm run lint
-  - npm run test
+  - npm run test
+  - npm run build
+  - node -e "require('./dist').DocumentStore"

README.md

@@ -10,6 +10,7 @@ Added support for the following features:
 - More like this
 - [Suggestions](#suggestions)
 - [Revisions](#revisions)
+- [Advanced patching](#advanced-patching)
 
 ### 4.0.2 - 2018-09-14
 Added support for the following features:
@@ -736,6 +737,16 @@ const suggestionQueryResult = await session.query({ collection: "users" })
 // { name: { name: 'name', suggestions: [ 'john' ] } }
 ```
 
+### Advanced patching
+```javascript
+session.advanced.increment("users/1", "age", 1);
+// increments *age* field by 1
+
+session.advanced.patch("users/1", "underAge", false);
+// sets *underAge* field to *false*
+
+await session.saveChanges();
+```
 
 ## Using object literals for entities
 

src/Documents/Commands/GetRevisionsCommand.ts

@@ -1,10 +1,12 @@
-import { DocumentConventions, IRavenArrayResult, ServerNode } from "../..";
-import { RavenCommand } from "../../../src/Http/RavenCommand";
 import { TypeUtil } from "../../Utility/TypeUtil";
 import { HttpRequestParameters } from "../../Primitives/Http";
 import { DateUtil } from "../../Utility/DateUtil";
 import * as stream from "readable-stream";
 import { GetDocumentsCommand } from "./GetDocumentsCommand";
+import { RavenCommand } from "../../Http/RavenCommand";
+import { IRavenArrayResult } from "../../Types";
+import { DocumentConventions } from "../Conventions/DocumentConventions";
+import { ServerNode } from "../../Http/ServerNode";
 
 export class GetRevisionsCommand extends RavenCommand<IRavenArrayResult> {
 

src/Documents/Operations/PatchOperation.ts

@@ -18,6 +18,7 @@ import { pick } from "stream-json/filters/Pick";
 import { filter } from "stream-json/filters/Filter";
 import { ignore } from "stream-json/filters/Ignore";
 import { parseRestOfOutput } from "../../Mapping/Json/Streams/Pipelines";
+import { ObjectUtil } from "../../Utility/ObjectUtil";
 
 export interface Payload {
     patch: PatchRequest;
@@ -128,7 +129,17 @@ export class PatchCommand extends RavenCommand<PatchResult> {
 
         this._id = id;
         this._changeVector = changeVector;
-        this._patch = conventions.objectMapper.toObjectLiteral({ patch, patchIfMissing });
+        this._patch = ObjectUtil.transformObjectKeys(
+            conventions.objectMapper.toObjectLiteral({ patch, patchIfMissing }),
+            {
+                defaultTransform: "pascal",
+                paths: [
+                    {
+                        transform: conventions.remoteEntityFieldNameConvention,
+                        path: /Values/i
+                    }
+                ]
+            });
         this._skipPatchIfChangeVectorMismatch = skipPatchIfChangeVectorMismatch;
         this._returnDebugInformation = returnDebugInformation;
         this._test = test;
@@ -154,7 +165,7 @@ export class PatchCommand extends RavenCommand<PatchResult> {
             uri += "&test=true";
         }
 
-        const body = this._serializer.serialize(this._patch);
+        const body = JSON.stringify(this._patch);
         const req = {
             method: "PATCH",
             uri,

…uments/Session/DocumentStreamIterable.ts …ocuments/Session/DocumentResultStream.tssrc/Documents/Session/DocumentStreamIterable.ts renamed to src/Documents/Session/DocumentResultStream.ts src/Documents/Session/DocumentStreamIterable.ts renamed to src/Documents/Session/DocumentResultStream.ts

@@ -2,10 +2,6 @@ import { StreamResult } from "../Commands/StreamResult";
 import { TypedEventEmitter } from "../../Primitives/Events";
 import { StreamQueryStatistics } from "./StreamQueryStatistics";
 
-export interface StreamingQueryEvents {
-    "afterStreamExecuted": object;
-}
-
 export interface DocumentStreamResultEvents<TEntity extends object> {
     data: StreamResult<TEntity>;
     error: Error;

src/Documents/Session/DocumentSession.ts

@@ -53,7 +53,7 @@ import { IRevisionsSessionOperations } from "./IRevisionsSessionOperations";
 import { DocumentSessionRevisions } from "./DocumentSessionRevisions";
 import * as StreamUtil from "../../Utility/StreamUtil";
 import { StreamResult } from "../Commands/StreamResult";
-import { DocumentResultStream } from "./DocumentStreamIterable";
+import { DocumentResultStream } from "./DocumentResultStream";
 import { StreamOperation } from "./Operations/StreamOperation";
 import { QueryOperation } from "./Operations/QueryOperation";
 import { StreamQueryStatisticsCallback } from "./IAdvancedSessionOperations";

src/Documents/Session/IAdvancedSessionOperations.ts

@@ -19,7 +19,7 @@ import { IEagerSessionOperations } from "./Operations/Lazy/IEagerSessionOperatio
 import { JavaScriptArray } from "./JavaScriptArray";
 import { IRevisionsSessionOperations } from "./IRevisionsSessionOperations";
 import * as stream from "readable-stream";
-import { DocumentResultStream } from "../Session/DocumentStreamIterable";
+import { DocumentResultStream } from "../Session/DocumentResultStream";
 
 export type StreamQueryStatisticsCallback = (stats: StreamQueryStatistics) => void;
 

src/index.ts

@@ -129,6 +129,7 @@ export {
     SetIndexesPriorityOperation,
     SetIndexesPriorityOperationParameters
 } from "./Documents/Operations/Indexes/SetIndexesPriorityOperation";
+export * from "./Documents/Operations/PatchRequest";
 
 // INDEXES
 export { GetIndexOperation } from "./Documents/Operations/Indexes/GetIndexOperation";
@@ -188,6 +189,7 @@ export * from "./Documents/Session/RawDocumentQuery";
 export * from "./Documents/Session/SessionEvents";
 export * from "./Documents/Session/WhereParams";
 export *  from "./Documents/Session/IMetadataDictionary";
+export *  from "./Documents/Session/DocumentResultStream";
 export * from "./Documents/Commands/StreamResult";
 
 // QUERIES

test/Documents/ReadmeSamples.ts

@@ -430,6 +430,31 @@ describe("Readme query samples", function () {
 
     });
 
+    it("can use advanced.patch", async () => {
+        store.conventions.findCollectionNameForObjectLiteral = () => "users";
+
+        {
+            const session = store.openSession();
+            await session.store({ name: "Matilda", age: 17, underAge: true }, "users/1");
+            await session.saveChanges();
+        }
+
+        {
+            const session = store.openSession();
+            session.advanced.increment("users/1", "age", 1);
+            session.advanced.patch("users/1", "underAge", false);
+            await session.saveChanges();
+        }
+
+        {
+            const session = store.openSession();
+            const loaded: any = await session.load("users/1");
+            assert.strictEqual(loaded.underAge, false);
+            assert.strictEqual(loaded.age, 18);
+            assert.strictEqual(loaded.name, "Matilda");
+        }
+    });
+
     describe("with revisions set up", function() {
 
         beforeEach(async () => testContext.setupRevisions(store, false, 5));

test/Ported/Server/Patching/AdvancedPatchingTest.ts

@@ -20,7 +20,7 @@ describe("AdvancedPatchingTest", function () {
     afterEach(async () =>
         await disposeTestDocumentStore(store));
 
-    it.skip("can test with variables", async () => {
+    it("can test with variables", async () => {
 
         {
             const session = store.openSession();