Merge pull request #37 from dolittle/fix-api-signatures

Fix api signatures

Author: woksin

.eslintrc.js

@@ -10,7 +10,7 @@ module.exports = {
         tsconfigRootDir: __dirname,
     },
     rules: {
-        "@typescript-eslint/no-this-alias": ['error', { allowedNames: ['self']}],
+        "@typescript-eslint/unified-signatures": 'off',
         "import/no-extraneous-dependencies": 'off'
     },
     overrides: [

Samples/Basic/index.ts

@@ -4,19 +4,21 @@
 import { Client } from '@dolittle/sdk';
 import { EventContext, PartitionId } from '@dolittle/sdk.events';
 import { PartitionedFilterResult } from '@dolittle/sdk.events.filtering';
+import { eventHandler } from '@dolittle/sdk.events.handling';
+import { TenantId } from '@dolittle/sdk.execution';
 
 import { MyEvent } from './MyEvent';
 import { MyEventHandler } from './MyEventHandler';
 
 const client = Client
     .forMicroservice('7a6155dd-9109-4488-8f6f-c57fe4b65bfb')
-    .withVersion(1, 0, 2)
-    .withEnvironment('test')
+    .withVersion(1, 3, 4)
+    .withEnvironment('secret mountain lab')
     .withEventTypes(eventTypes =>
         eventTypes.register(MyEvent))
-    .withEventHandlers(eventHandlers =>
-        eventHandlers
-            .register(MyEventHandler))
+    .withEventHandlers(eventHandlers => {
+        eventHandlers.register(MyEventHandler);
+    })
     .withFilters(filterBuilder =>
         filterBuilder
             .createPrivateFilter('79e12ab3-2751-47e1-b959-d898dc4d6ee8', fb =>
@@ -36,12 +38,11 @@ const client = Client
     )
     .build();
 
-
 const event = new MyEvent();
 event.anInteger = 42;
 event.aString = 'Forty two';
 
 client
     .eventStore
-    .forTenant('900893e7-c4cc-4873-8032-884e965e4b97')
+    .forTenant(TenantId.development)
     .commitPublic(event, 'd8cb7301-4bec-4451-a72b-2db53c6dc05d');

Source/artifacts/EventTypeOptions.ts

@@ -0,0 +1,6 @@
+// Copyright (c) Dolittle. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Generation } from './Generation';
+
+export type EventTypeOptions = { generation?: Generation | number };

Source/artifacts/EventTypes.ts

@@ -61,7 +61,7 @@ export class EventTypes implements IEventTypes {
     /** @inheritdoc */
     resolveFrom(object: any, input?: EventType | EventTypeId | Guid | string): EventType {
         let eventType: EventType | undefined;
-        if (input != null) {
+        if (input !== undefined) {
             eventType = input instanceof EventType ? input : new EventType(EventTypeId.from(input));
         } else if (object && this.hasFor(Object.getPrototypeOf(object).constructor)) {
             eventType = this.getFor(Object.getPrototypeOf(object).constructor);

Source/artifacts/EventTypesBuilder.ts

@@ -21,21 +21,36 @@ export class EventTypesBuilder {
     /**
      * Associate a type with an unique event type identifier and optional generation.
      * @param {Constructor} type Type to associate.
-     * @param {ArtifactId} identifier Identifier to associate with.
-     * @param {number} generation Optional generation - defaults to 1.
+     * @param {EventType} eventType EventType to associate with.
      */
     associate<T = any>(type: Constructor<T>, eventType: EventType): EventTypesBuilder;
-    associate<T = any>(type: Constructor<T>, identifier: EventTypeId | Guid | string, generation?: Generation | number): EventTypesBuilder;
+    /**
+     * Associate a type with an unique event type identifier and optional generation.
+     * @param {Constructor} type Type to associate.
+     * @param {EventTypeId | Guid | string} identifier Identifier to associate with.
+     */
+    associate<T = any>(type: Constructor<T>, identifier: EventTypeId | Guid | string): EventTypesBuilder;
+    /**
+     * Associate a type with an unique event type identifier and optional generation.
+     * @param {Constructor} type Type to associate.
+     * @param {EventTypeId | Guid | string} identifier Identifier to associate with.
+     * @param {Generation | number} generation The generation to associate with.
+     */
+    associate<T = any>(type: Constructor<T>, identifier: EventTypeId | Guid | string, generation: Generation | number): EventTypesBuilder;
     associate<T = any>(type: Constructor<T>, eventTypeOrIdentifier: EventType | EventTypeId | Guid | string, generation?: Generation | number): EventTypesBuilder {
         const eventType = eventTypeOrIdentifier instanceof EventType ?
                             eventTypeOrIdentifier
                             : new EventType(
                                 EventTypeId.from(eventTypeOrIdentifier),
-                                generation == null? Generation.first : Generation.from(generation));
+                                generation ? Generation.from(generation) : Generation.first);
         this._associations.push([type, eventType]);
         return this;
     }
 
+    /**
+     * Register the type as an {@link EventType}.
+     * @param type The type to register as an {@link EventType}
+     */
     register<T = any>(type: Constructor<T>): EventTypesBuilder {
         this.associate(type, EventTypesFromDecorators.eventTypes.getFor(type));
         return this;

Source/artifacts/eventTypeDecorator.ts

@@ -2,20 +2,22 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 import { Guid } from '@dolittle/rudiments';
-import { EventType } from './EventType';
 import { EventTypeId } from './EventTypeId';
+import { EventTypeOptions } from './EventTypeOptions';
 import { EventTypesFromDecorators } from './EventTypesFromDecorators';
 import { Generation } from './Generation';
 
 /**
  * Decorator for associating an event with an artifact.
+ * @param {EventTypeId | Guid | string} identifier The id to associate with this type
+ * @param {EventTypeOptions} [options={} Options to give to the EventHandler
  */
-export function eventType(identifier: Guid | string, generationNumber?: number) {
+export function eventType(identifier: EventTypeId | Guid | string, options: EventTypeOptions = {}) {
     return function (target: any) {
         EventTypesFromDecorators
             .associate(
                 target.prototype.constructor,
                 EventTypeId.from(identifier),
-                generationNumber != null ? Generation.from(generationNumber) : Generation.first);
+                options.generation ? Generation.from(options.generation) : Generation.first);
     };
 }

Source/eventHorizon/SubscriptionBuilderForProducerMicroservice.ts

@@ -30,9 +30,9 @@ export class SubscriptionBuilderForProducerMicroservice {
 
     /**
      * Specifies from which tenant we should get events from in the other microservice.
-     * @param {Guid | string} tenantId Tenant for the subscription.
+     * @param {TenantId | Guid | string} tenantId Tenant for the subscription.
      */
-    fromProducerTenant(tenantId: Guid | string): SubscriptionBuilderForProducerTenant {
+    fromProducerTenant(tenantId: TenantId | Guid | string): SubscriptionBuilderForProducerTenant {
         this.throwIfProducerTenantIsAlreadyDefined();
         this._producerTenantId = TenantId.from(tenantId);
         this._builder = new SubscriptionBuilderForProducerTenant(this._producerMicroserviceId, this._producerTenantId);

Source/eventHorizon/SubscriptionBuilderForProducerPartition.ts

@@ -34,9 +34,9 @@ export class SubscriptionBuilderForProducerPartition {
 
     /**
      * Sets the producer stream to subscribe to events from.
-     * @param {Guid | string} scopeId Stream to subscribe to events from.
+     * @param {ScopeId | Guid | string} scopeId Stream to subscribe to events from.
      */
-    toScope(scopeId: Guid | string): SubscriptionBuilderForConsumerScope {
+    toScope(scopeId: ScopeId | Guid | string): SubscriptionBuilderForConsumerScope {
         this.throwIfConsumerScopeIsAlreadyDefined();
         this._consumerScopeId = ScopeId.from(scopeId);
         this._builder = new SubscriptionBuilderForConsumerScope(

Source/eventHorizon/SubscriptionBuilderForProducerStream.ts

@@ -33,9 +33,9 @@ export class SubscriptionBuilderForProducerStream {
 
     /**
      * Sets the producer stream to subscribe to events from.
-     * @param {Guid | string} tenant Stream to subscribe to events from.
+     * @param {PartitionId | Guid | string} tenant Stream to subscribe to events from.
      */
-    fromProducerPartition(partitionId: Guid | string): SubscriptionBuilderForProducerPartition {
+    fromProducerPartition(partitionId: PartitionId | Guid | string): SubscriptionBuilderForProducerPartition {
         this.throwIfProducerPartitionIsAlreadyDefined();
         this._producerPartitionId = PartitionId.from(partitionId);
         this._builder = new SubscriptionBuilderForProducerPartition(

Source/eventHorizon/SubscriptionBuilderForProducerTenant.ts

@@ -32,9 +32,9 @@ export class SubscriptionBuilderForProducerTenant {
 
     /**
      * Sets the producer stream to subscribe to events from.
-     * @param {Guid | string} tenant Stream to subscribe to events from.
+     * @param {StreamId | Guid | string} tenant Stream to subscribe to events from.
      */
-    fromProducerStream(streamId: Guid | string): SubscriptionBuilderForProducerStream {
+    fromProducerStream(streamId: StreamId | Guid | string): SubscriptionBuilderForProducerStream {
         this.throwIfProducerStreamIsAlreadyDefined();
         this._producerStreamId = StreamId.from(streamId);
         this._builder = new SubscriptionBuilderForProducerStream(