Added a Operation result event for addAnnotation. (#181)

Partially fixes https://github.com/PSPDFKit/react-native/issues/169

Adds a promise to add annotation to ensure that the creation is successful.

Author: nickwinder

index.windows.js

@@ -27,6 +27,7 @@ class PSPDFKitView extends React.Component {
         onDocumentSaved={this._onDocumentSaved}
         onDocumentSaveFailed={this._onDocumentSaveFailed}
         onDataReturned={this._onDataReturned}
+        onOperationResult={this._onOperationResult}
       />
     );
   }
@@ -60,6 +61,17 @@ class PSPDFKitView extends React.Component {
     this._requestMap.delete(requestId);
   };
 
+  _onOperationResult = event => {
+    let {requestId, success, error} = event.nativeEvent;
+    let promise = this._requestMap[requestId];
+    if (success) {
+      promise.resolve(success);
+    } else {
+      promise.reject(error);
+    }
+    this._requestMap.delete(requestId);
+  };
+
   /**
    * Enters the annotation creation mode, showing the annotation creation toolbar.
    */
@@ -124,14 +136,29 @@ class PSPDFKitView extends React.Component {
    *
    * @param annotation InstantJson of the annotation to add with the format of
    * https://pspdfkit.com/guides/windows/current/importing-exporting/instant-json/#instant-annotation-json-api
+   *
+   * @returns a promise resolving with a successful payload if annotation is created.
+   * {'success' : boolean}
+   * If success is false an error will also be held.
+   * {'error' : string}
    */
   addAnnotation(annotation) {
+    let requestId = this._nextRequestId++;
+    let requestMap = this._requestMap;
+
+    // We create a promise here that will be resolved once onDataReturned is called.
+    let promise = new Promise(function (resolve, reject) {
+      requestMap[requestId] = {resolve: resolve, reject: reject};
+    });
+
     UIManager.dispatchViewManagerCommand(
       findNodeHandle(this.refs.pdfView),
       UIManager.RCTPSPDFKitView.Commands.addAnnotation,
-      [annotation]
+      [requestId, annotation]
     );
-  }
+
+    return promise;
+  };
 
   /**
    * Gets toolbar items currently shown.

samples/Catalog/Catalog.windows.js

@@ -44,6 +44,40 @@ const complexSearchConfiguration = {
   previewRange: {position: 20, length: 120}
 };
 
+const annotationToAdd = {
+  bbox: [
+    89.58633422851562,
+    98.5791015625,
+    143.12948608398438,
+    207.1583251953125
+  ],
+  blendMode: "normal",
+  createdAt: "2018-07-03T13:53:03Z",
+  isDrawnNaturally: false,
+  lineWidth: 5,
+  lines: {
+    intensities: [[0.5, 0.5, 0.5], [0.5, 0.5, 0.5]],
+    points: [
+      [
+        [92.08633422851562, 101.07916259765625],
+        [92.08633422851562, 202.15826416015625],
+        [138.12950134277344, 303.2374267578125]
+      ],
+      [
+        [184.17266845703125, 101.07916259765625],
+        [184.17266845703125, 202.15826416015625],
+        [230.2158203125, 303.2374267578125]
+      ]
+    ]
+  },
+  opacity: 1,
+  pageIndex: 0,
+  strokeColor: "#AA47BE",
+  type: "pspdfkit/ink",
+  updatedAt: "2018-07-03T13:53:03Z",
+  v: 1
+};
+
 const simpleSearch = {
   searchString: "the"
 };
@@ -363,38 +397,10 @@ class PdfViewInstantJsonScreen extends Component<{}> {
             <Button
               onPress={() => {
                 // This adds a new ink annotation to the first page.
-                this.refs.pdfView.addAnnotation({
-                  bbox: [
-                    89.58633422851562,
-                    98.5791015625,
-                    143.12948608398438,
-                    207.1583251953125
-                  ],
-                  blendMode: "normal",
-                  createdAt: "2018-07-03T13:53:03Z",
-                  isDrawnNaturally: false,
-                  lineWidth: 5,
-                  lines: {
-                    intensities: [[0.5, 0.5, 0.5], [0.5, 0.5, 0.5]],
-                    points: [
-                      [
-                        [92.08633422851562, 101.07916259765625],
-                        [92.08633422851562, 202.15826416015625],
-                        [138.12950134277344, 303.2374267578125]
-                      ],
-                      [
-                        [184.17266845703125, 101.07916259765625],
-                        [184.17266845703125, 202.15826416015625],
-                        [230.2158203125, 303.2374267578125]
-                      ]
-                    ]
-                  },
-                  opacity: 1,
-                  pageIndex: 0,
-                  strokeColor: "#AA47BE",
-                  type: "pspdfkit/ink",
-                  updatedAt: "2018-07-03T13:53:03Z",
-                  v: 1
+                this.refs.pdfView.addAnnotation(annotationToAdd).then(() => {
+                  alert("Annotation Creation was successful.");
+                }).catch(error => {
+                  alert(error);
                 });
               }}
               title="Add annotation"

windows/ReactNativePSPDFKit/ReactNativePSPDFKit/Events/PdfViewOperationResult.cs

@@ -0,0 +1,35 @@
+using Newtonsoft.Json.Linq;
+using ReactNative.UIManager.Events;
+
+namespace ReactNativePSPDFKit.Events
+{
+    class PdfViewOperationResult : Event
+    {
+        /**
+         * Event sent by the PDFViewPage when a operation has succeeded
+         */
+        public const string EVENT_NAME = "pdfViewOperationSuccessful";
+
+        private readonly JObject _payload = new JObject();
+
+        public PdfViewOperationResult(int viewId, int requestId) : base(viewId)
+        {
+            _payload.Add("requestId", requestId);
+            _payload.Add("success", true);
+        }
+
+        public PdfViewOperationResult(int viewId, int requestId, string errorMessage) : base(viewId)
+        {
+            _payload.Add("requestId", requestId);
+            _payload.Add("success", false);
+            _payload.Add("error", errorMessage);
+        }
+
+        public override string EventName => EVENT_NAME;
+
+        public override void Dispatch(RCTEventEmitter rctEventEmitter)
+        {
+            rctEventEmitter.receiveEvent(ViewTag, EventName, _payload);
+        }
+    }
+}

windows/ReactNativePSPDFKit/ReactNativePSPDFKit/PDFViewPage.xaml.cs

@@ -159,6 +159,24 @@ internal async Task SetToolbarItems(int requestId, string toolbarItemsJson)
             }
         }
 
+        public async Task CreateAnnotation(int requestId, string annotationJsonString)
+        {
+            try
+            {
+                await Pdfview.Document.CreateAnnotationAsync(Factory.FromJson(JsonObject.Parse(annotationJsonString)));
+
+                this.GetReactContext().GetNativeModule<UIManagerModule>().EventDispatcher.DispatchEvent(
+                    new PdfViewOperationResult(this.GetTag(), requestId)
+                );
+            }
+            catch (Exception e)
+            {
+                this.GetReactContext().GetNativeModule<UIManagerModule>().EventDispatcher.DispatchEvent(
+                    new PdfViewOperationResult(this.GetTag(), requestId, e.Message)
+                );
+            }
+        }
+
         internal async Task SetPageIndexAsync(int index)
         {
            await PDFView.Controller.SetCurrentPageIndexAsync(index);

windows/ReactNativePSPDFKit/ReactNativePSPDFKit/PSPDFKitViewManager.cs

@@ -105,7 +105,7 @@ public override async void ReceiveCommand(PDFViewPage view, int commandId, JArra
                     await PdfViewPage.GetAnnotations(args[0].Value<int>(), args[1].Value<int>());
                     break;
                 case COMMAND_ADD_ANNOTATION:
-                    await PdfViewPage.Pdfview.Document.CreateAnnotationAsync(Factory.FromJson(JsonObject.Parse(args[0].ToString())));
+                    await PdfViewPage.CreateAnnotation(args[0].Value<int>(), args[1].ToString());
                     break;
                 case COMMAND_GET_TOOLBAR_ITEMS:
                     PdfViewPage.GetToolbarItems(args[0].Value<int>());
@@ -146,6 +146,13 @@ public override async void ReceiveCommand(PDFViewPage view, int commandId, JArra
                     {
                         {"registrationName", "onDataReturned"},
                     }
+                },
+                {
+                    PdfViewOperationResult.EVENT_NAME,
+                    new JObject
+                    {
+                        {"registrationName", "onOperationResult"},
+                    }
                 }
             };
     }

windows/ReactNativePSPDFKit/ReactNativePSPDFKit/ReactNativePSPDFKit.csproj

@@ -110,6 +110,7 @@
     <Compile Include="Events\PdfViewDocumentSavedEvent.cs" />
     <Compile Include="Events\PdfViewDataReturnedEvent.cs" />
     <Compile Include="Events\PdfViewDocumentSaveFailedEvent.cs" />
+    <Compile Include="Events\PdfViewOperationResult.cs" />
     <Compile Include="JsonUtils.cs" />
     <Compile Include="LibraryModule.cs" />
     <Compile Include="PSPDFKitModule.cs" />