Merge pull request #32 from dolittle/commit-events-result

Change to CommitEventsResult

Author: jakhog

Source/events/CommitEventsResponse.ts Source/events/CommitEventsResult.tsSource/events/CommitEventsResponse.ts renamed to Source/events/CommitEventsResult.ts

@@ -5,12 +5,12 @@ import { Failure } from '@dolittle/sdk.protobuf';
 import { CommittedEvents } from './CommittedEvents';
 
 /**
- * Represents the response from a commit of events
+ * Represents the result from a commit of events
  */
-export class CommitEventsResponse {
+export class CommitEventsResult {
 
     /**
-     * Initializes a new instance of {@link CommitEventsResponse}
+     * Initializes a new instance of {@link CommitEventsResult}
      * @param {CommittedEvents} events Events committed.
      * @param {Failure} failure Failure from the response.
      */

Source/events/EventStore.ts

@@ -18,7 +18,7 @@ import { IEventStore } from './IEventStore';
 import { EventSourceId } from './EventSourceId';
 import { UncommittedEvent } from './UncommittedEvent';
 import { EventConverters } from './EventConverters';
-import { CommitEventsResponse } from './CommitEventsResponse';
+import {CommitEventsResult } from './CommitEventsResult';
 import { Guid } from '@dolittle/rudiments';
 
 /**
@@ -41,9 +41,9 @@ export class EventStore implements IEventStore {
     }
 
     /** @inheritdoc */
-    commit(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResponse>;
-    commit(events: UncommittedEvent[], cancellation?: Cancellation): Promise<CommitEventsResponse>;
-    commit(eventOrEvents: any, eventSourceIdOrCancellation?: Guid | string | Cancellation, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResponse> {
+    commit(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResult>;
+    commit(events: UncommittedEvent[], cancellation?: Cancellation): Promise<CommitEventsResult>;
+    commit(eventOrEvents: any, eventSourceIdOrCancellation?: Guid | string | Cancellation, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResult> {
         if (this.isArrayOfUncommittedEvents(eventOrEvents)) {
             return this.commitInternal(eventOrEvents, eventSourceIdOrCancellation as Cancellation);
         }
@@ -52,7 +52,7 @@ export class EventStore implements IEventStore {
     }
 
     /** @inheritdoc */
-    commitPublic(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResponse> {
+    commitPublic(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResult> {
         const events: UncommittedEvent[] = [this.toUncommittedEvent(event, eventSourceId, eventType, true)];
         return this.commitInternal(events, cancellation);
     }
@@ -61,7 +61,7 @@ export class EventStore implements IEventStore {
         return Array.isArray(eventOrEvents) && eventOrEvents.length > 0 && eventOrEvents[0].eventSourceId && eventOrEvents[0].content;
     }
 
-    private async commitInternal(events: UncommittedEvent[], cancellation = Cancellation.default): Promise<CommitEventsResponse> {
+    private async commitInternal(events: UncommittedEvent[], cancellation = Cancellation.default): Promise<CommitEventsResult> {
         const uncommittedEvents = events.map(event =>
             EventConverters.getUncommittedEventFrom(
                 event.content,
@@ -76,7 +76,7 @@ export class EventStore implements IEventStore {
         return reactiveUnary(this._eventStoreClient, this._eventStoreClient.commit, request, cancellation)
             .pipe(map(response => {
                 const committedEvents = new CommittedEvents(...response.getEventsList().map(event => EventConverters.toSDK(event)));
-                return new CommitEventsResponse(committedEvents, failures.toSDK(response.getFailure()));
+                return new CommitEventsResult(committedEvents, failures.toSDK(response.getFailure()));
             })).toPromise();
     }
 

Source/events/IEventStore.ts

@@ -5,7 +5,7 @@ import { Guid } from '@dolittle/rudiments';
 import { EventType } from '@dolittle/sdk.artifacts';
 import { Cancellation } from '@dolittle/sdk.resilience';
 
-import { CommitEventsResponse } from './CommitEventsResponse';
+import { CommitEventsResult } from './CommitEventsResult';
 import { UncommittedEvent } from './UncommittedEvent';
 ;
 
@@ -20,31 +20,31 @@ export interface IEventStore {
      * @param eventSourceId The source of the event - a unique identifier that is associated with the event.
      * @param {EventType|Guid|string} [eventType] An event type or an identifier representing the event type.
      * @param {Cancellation} cancellation The cancellation signal.
-     * @returns Promise<CommitEventsResponse>
+     * @returns Promise<CommitEventsResult>
      * @summary If no event type identifier or event type is supplied, it will look for associated event types based
      * on the actual type of the event.
      */
-    commit(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResponse>;
+    commit(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResult>;
 
     /**
      * Commit a collection of events.
      * @param {UncommittedEvent[]} events Collection of events.
      * @param {Cancellation} cancellation The cancellation signal.
-     * @returns Promise<CommitEventsResponse>
+     * @returns Promise<CommitEventsResult>
      * @summary If no event type identifier or event type is supplied, it will look for associated event types based
      * @summary on the actual type of the event.
      */
-    commit(events: UncommittedEvent[], cancellation?: Cancellation): Promise<CommitEventsResponse>;
+    commit(events: UncommittedEvent[], cancellation?: Cancellation): Promise<CommitEventsResult>;
 
     /**
      * Commit a single public event.
      * @param {*} event The content of the event.
      * @param eventSourceId The source of the event - a unique identifier that is associated with the event.
      * @param {EventType|Guid|string} [eventType] An event type or an identifier representing the event type.
      * @param {Cancellation} cancellation The cancellation signal.
-     * @returns Promise<CommitEventsResponse>
+     * @returns Promise<CommitEventsResult>
      * @summary If no event type identifier or event type is supplied, it will look for associated event types based
      * on the actual type of the event.
      */
-    commitPublic(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResponse>;
+    commitPublic(event: any, eventSourceId: Guid | string, eventType?: EventType | Guid | string, cancellation?: Cancellation): Promise<CommitEventsResult>;
 }

Source/events/index.ts

@@ -13,7 +13,7 @@ export { EventContext } from './EventContext';
 export { EventStore } from './EventStore';
 export { CommittedEvent } from './CommittedEvent';
 export { CommittedEvents } from './CommittedEvents';
-export { CommitEventsResponse } from './CommitEventsResponse';
+export { CommitEventsResult } from './CommitEventsResult';
 export { EventConverters } from './EventConverters';
 export { IEventStore } from './IEventStore';
 export { UncommittedEvent } from './UncommittedEvent';