Merge pull request #77 from dolittle/dolittle-client

woksin · web-flow · commit 2820ca309bb2 · 2021-11-10T11:21:08.000+01:00
Dolittle client
diff --git a/Samples/Advanced/index.ts b/Samples/Advanced/index.ts
@@ -1,14 +1,14 @@
 // Copyright (c) Dolittle. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { EventContext, PartitionId } from '@dolittle/sdk.events';
 import { PartitionedFilterResult } from '@dolittle/sdk.events.filtering';
 
 import { MyEvent } from './MyEvent';
 import { MyEventHandler } from './MyEventHandler';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('7a6155dd-9109-4488-8f6f-c57fe4b65bfb')
     .withVersion(1, 0, 2)
     .withEnvironment('test')
diff --git a/Samples/Container/index.ts b/Samples/Container/index.ts
@@ -2,14 +2,14 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 import 'reflect-metadata';
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { Container } from 'typedi';
 
 import { MyEvent } from './MyEvent';
 import { MyEventHandler } from './MyEventHandler';
 
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('7a6155dd-9109-4488-8f6f-c57fe4b65bfb')
     .withContainer(Container)
     .withEventTypes(eventTypes =>
diff --git a/Samples/Tutorials/Aggregates/index.ts b/Samples/Tutorials/Aggregates/index.ts
@@ -2,14 +2,14 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/tutorials/aggregates/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { TenantId } from '@dolittle/sdk.execution';
 import { DishPrepared } from './DishPrepared';
 import { DishHandler } from './DishHandler';
 import { Kitchen } from './Kitchen';
 
 (async () => {
-    const client = Client
+    const client = DolittleClient
         .forMicroservice('f39b1f61-d360-4675-b859-53c05c87c0e6')
         .withEventTypes(eventTypes =>
             eventTypes.register(DishPrepared))
diff --git a/Samples/Tutorials/Embeddings/index.ts b/Samples/Tutorials/Embeddings/index.ts
@@ -2,14 +2,14 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/docs/tutorials/embeddings/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { TenantId } from '@dolittle/sdk.execution';
 import { Employee } from './Employee';
 import { EmployeeHired } from './EmployeeHired';
 import { EmployeeRetired } from './EmployeeRetired';
 import { EmployeeTransferred } from './EmployeeTransferred';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('f39b1f61-d360-4675-b859-53c05c87c0e6')
     .withEventTypes(eventTypes => {
         eventTypes.register(EmployeeHired);
diff --git a/Samples/Tutorials/EventHorizon/Consumer/index.ts b/Samples/Tutorials/EventHorizon/Consumer/index.ts
@@ -2,12 +2,12 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/tutorials/event-horizon/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { PartitionId } from '@dolittle/sdk.events';
 import { TenantId } from '@dolittle/sdk.execution';
 import { DishPrepared } from './DishPrepared';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('a14bb24e-51f3-4d83-9eba-44c4cffe6bb9')
     .withRuntimeOn('localhost', 50055)
     .withEventTypes(eventTypes =>
diff --git a/Samples/Tutorials/EventHorizon/Producer/index.ts b/Samples/Tutorials/EventHorizon/Producer/index.ts
@@ -2,14 +2,14 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/tutorials/event-horizon/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { EventContext, PartitionId } from '@dolittle/sdk.events';
 import { PartitionedFilterResult } from '@dolittle/sdk.events.filtering';
 import { TenantId } from '@dolittle/sdk.execution';
 import { DishPrepared } from './DishPrepared';
 import { DishHandler } from './DishHandler';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('f39b1f61-d360-4675-b859-53c05c87c0e6')
     .withEventTypes(eventTypes =>
         eventTypes.register(DishPrepared))
diff --git a/Samples/Tutorials/GettingStarted/index.ts b/Samples/Tutorials/GettingStarted/index.ts
@@ -2,12 +2,12 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/tutorials/getting-started/typescript/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { TenantId } from '@dolittle/sdk.execution';
 import { DishPrepared } from './DishPrepared';
 import { DishHandler } from './DishHandler';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('f39b1f61-d360-4675-b859-53c05c87c0e6')
     .withEventTypes(eventTypes =>
         eventTypes.register(DishPrepared))
diff --git a/Samples/Tutorials/Projections/index.ts b/Samples/Tutorials/Projections/index.ts
@@ -2,13 +2,13 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 // Sample code for the tutorial at https://dolittle.io/docs/tutorials/projections/
 
-import { Client } from '@dolittle/sdk';
+import { DolittleClient } from '@dolittle/sdk';
 import { TenantId } from '@dolittle/sdk.execution';
 import { DishPrepared } from './DishPrepared';
 import { DishCounter } from './DishCounter';
 import { Chef } from './Chef';
 
-const client = Client
+const client = DolittleClient
     .forMicroservice('f39b1f61-d360-4675-b859-53c05c87c0e6')
     .withEventTypes(eventTypes =>
         eventTypes.register(DishPrepared))
diff --git a/Source/embeddings/Embeddings.ts b/Source/embeddings/Embeddings.ts
@@ -4,18 +4,18 @@
 import { Guid } from '@dolittle/rudiments';
 import { EmbeddingsClient } from '@dolittle/runtime.contracts/Embeddings/Embeddings_grpc_pb';
 import { EmbeddingStoreClient } from '@dolittle/runtime.contracts/Embeddings/Store_grpc_pb';
-import { ExecutionContext, TenantId } from '@dolittle/sdk.execution';
+import { ExecutionContext, TenantIdLike } from '@dolittle/sdk.execution';
 import { IProjectionAssociations, ProjectionsToSDKConverter } from '@dolittle/sdk.projections';
 import { Logger } from 'winston';
 import { Embedding } from './Embedding';
 import { IEmbedding } from './IEmbedding';
-import { EmbeddingStore, IEmbeddingStore, EmbeddingStoreBuilder } from './Store';
+import { IEmbeddings } from './IEmbeddings';
+import { EmbeddingStoreBuilder } from './Store';
 
 /**
- * Represents a builder for building an embedding sdk client.
+ * Represents an implementation of {@link IEmbeddings}.
  */
-export class Embeddings {
-
+export class Embeddings extends IEmbeddings {
     /**
      * Initializes an instance of {@link EmbeddingStoreBuilder}.
      * @param {EmbeddingStoreClient} _embeddingsStoreClient The embedding store client.
@@ -29,14 +29,11 @@ export class Embeddings {
         private readonly _executionContext: ExecutionContext,
         private readonly _embeddingAssociations: IProjectionAssociations,
         private readonly _logger: Logger) {
+            super();
     }
 
-    /**
-     * Build an {@link IEmbeddingStore} for the given tenant.
-     * @param {TenantId | Guid | string} tenantId The tenant id.
-     * @returns {IEmbeddingStore} The embedding store.
-     */
-    forTenant(tenantId: TenantId | Guid | string): IEmbedding {
+    /** @inheritdoc */
+    forTenant(tenantId: TenantIdLike): IEmbedding {
         const executionContext = this._executionContext
             .forTenant(tenantId)
             .forCorrelation(Guid.create());
diff --git a/Source/embeddings/IEmbeddings.ts b/Source/embeddings/IEmbeddings.ts
@@ -0,0 +1,16 @@
+// Copyright (c) Dolittle. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { TenantIdLike } from '@dolittle/sdk.execution';
+import { IEmbedding } from './IEmbedding';
+
+/**
+ * Defines a builder for {@link IEmbedding}.
+ */
+export abstract class IEmbeddings {
+    /**
+     * Build an {@link IEmbeddingStore} for the given tenant.
+     * @param { TenantIdLike } tenantId The tenant id.
+     * @returns {IEmbeddingStore} The embedding store.
+     */
+    abstract forTenant(tenantId: TenantIdLike): IEmbedding;
+}
diff --git a/Source/embeddings/index.ts b/Source/embeddings/index.ts
@@ -35,6 +35,7 @@ export { EmbeddingDeleteCallback } from './EmbeddingDeleteCallback';
 export { EmbeddingId } from './EmbeddingId';
 export { EmbeddingProjectCallback } from './EmbeddingProjectCallback';
 export { EmbeddingProjectContext } from './EmbeddingProjectContext';
+export { IEmbeddings } from './IEmbeddings';
 export { Embeddings } from './Embeddings';
 export { FailedToDelete } from './FailedToDelete';
 export { FailedToGetUpdatedState } from './FailedToGetUpdatedState';
diff --git a/Source/events/index.ts b/Source/events/index.ts
@@ -26,7 +26,8 @@ export {
     MissingExecutionContext,
     UncommittedAggregateEvent,
     UncommittedAggregateEvents,
-    UncommittedEvent
+    UncommittedEvent,
+    IEventStoreBuilder
 } from './store';
 
 export { EventLogSequenceNumberMustBeAPositiveInteger } from './EventLogSequenceNumberMustBeAPositiveInteger';
diff --git a/Source/events/store/builders/EventStoreBuilder.ts b/Source/events/store/builders/EventStoreBuilder.ts
@@ -1,31 +1,36 @@
 // Copyright (c) Dolittle. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { ExecutionContext, TenantId } from '@dolittle/sdk.execution';
+import { ExecutionContext, TenantId, TenantIdLike } from '@dolittle/sdk.execution';
 import { Logger } from 'winston';
 import { Guid } from '@dolittle/rudiments';
 import { IEventTypes } from '../../index';
 import { IEventStore, EventStore } from '../index';
 import { EventStoreClient } from '@dolittle/runtime.contracts/Events/EventStore_grpc_pb';
+import { IEventStoreBuilder } from '.';
 
 /**
- * Represents a builder for building an event store.
+ * Represents an implementation of {@link IEventStoreBuilder}.
  */
-export class EventStoreBuilder {
+export class EventStoreBuilder extends IEventStoreBuilder{
 
+    /**
+     * Initializes a new instance of {@link EventStoreBuilder}.
+     * @param {EventStoreClient} eventStoreClient The event store client.
+     * @param {IEventTypes} eventTypes The event types.
+     * @param {ExecutionContext} executionContext The execution context.
+     * @param {Logger} logger The logger.
+     */
     constructor(
-        private _eventStoreClient: EventStoreClient,
-        private _eventTypes: IEventTypes,
-        private _executionContext: ExecutionContext,
-        private _logger: Logger) {
+        private readonly _eventStoreClient: EventStoreClient,
+        private readonly _eventTypes: IEventTypes,
+        private readonly _executionContext: ExecutionContext,
+        private readonly _logger: Logger) {
+            super();
     }
 
-    /**
-     * Build an {@link IEventStore} for the given tenant.
-     * @param {TenantId | Guid | string} tenantId The tenant id.
-     * @returns {IEventStore} The event store.
-     */
-    forTenant(tenantId: TenantId | Guid | string): IEventStore {
+    /** @inheritdoc */
+    forTenant(tenantId: TenantIdLike): IEventStore {
         const executionContext = this._executionContext
             .forTenant(tenantId)
             .forCorrelation(Guid.create());
diff --git a/Source/events/store/builders/IEventStoreBuilder.ts b/Source/events/store/builders/IEventStoreBuilder.ts
@@ -0,0 +1,17 @@
+// Copyright (c) Dolittle. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { TenantIdLike } from '@dolittle/sdk.execution';
+import { IEventStore } from '../index';
+
+/**
+ * Defines a builder for {@link IEventStore}.
+ */
+
+export abstract class IEventStoreBuilder {
+    /**
+     * Build an {@link IEventStore} for the given tenant.
+     * @param {TenantIdLike} tenantId The tenant id.
+     * @returns {IEventStore} The event store.
+     */
+    abstract forTenant(tenantId: TenantIdLike): IEventStore;
+}
diff --git a/Source/events/store/builders/index.ts b/Source/events/store/builders/index.ts
@@ -5,4 +5,5 @@ export { CommitForAggregateBuilder } from './CommitForAggregateBuilder';
 export { CommitForAggregateWithEventSourceAndExpectedVersionBuilder } from './CommitForAggregateWithEventSourceAndExpectedVersionBuilder';
 export { CommitForAggregateWithEventSourceBuilder } from './CommitForAggregateWithEventSourceBuilder';
 export { EventBuilderMethodAlreadyCalled } from './EventBuilderMethodAlreadyCalled';
+export { IEventStoreBuilder } from './IEventStoreBuilder';
 export { EventStoreBuilder } from './EventStoreBuilder';
diff --git a/Source/events/store/index.ts b/Source/events/store/index.ts
@@ -6,6 +6,7 @@ export {
     CommitForAggregateWithEventSourceAndExpectedVersionBuilder,
     CommitForAggregateWithEventSourceBuilder,
     EventBuilderMethodAlreadyCalled,
+    IEventStoreBuilder,
     EventStoreBuilder
 } from './builders';
 
diff --git a/Source/execution/TenantId.ts b/Source/execution/TenantId.ts
@@ -4,6 +4,8 @@
 import { Guid } from '@dolittle/rudiments';
 import { ConceptAs } from '@dolittle/concepts';
 
+export type TenantIdLike = string | Guid | TenantId;
+
 /**
  * Represents the unique identifier of a tenant.
  */
@@ -31,10 +33,10 @@ export class TenantId extends ConceptAs<Guid, '@dolittle/sdk.execution.TenantId'
      * Creates a {TenantId} from a guid.
      *
      * @static
-     * @param {string | Guid | TenantId} id
+     * @param {TenantIdLike} id
      * @returns {TenantId}
      */
-    static from(id: string | Guid | TenantId): TenantId {
+    static from(id: TenantIdLike): TenantId {
         if (id instanceof TenantId) return id;
         return new TenantId(Guid.as(id));
     };
diff --git a/Source/execution/index.ts b/Source/execution/index.ts
@@ -7,7 +7,7 @@ export { CorrelationId } from './CorrelationId';
 export { Environment } from './Environment';
 export { ExecutionContext } from './ExecutionContext';
 export { MicroserviceId } from './MicroserviceId';
-export { TenantId } from './TenantId';
+export { TenantId, TenantIdLike } from './TenantId';
 export { Version } from './Version';
 
 import './ExecutionContextExtensions';
diff --git a/Source/projections/Store/Builder/IProjectionStoreBuilder.ts b/Source/projections/Store/Builder/IProjectionStoreBuilder.ts
@@ -0,0 +1,17 @@
+// Copyright (c) Dolittle. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { TenantIdLike } from '@dolittle/sdk.execution';
+import { IProjectionStore } from '..';
+
+/**
+ * Defines a builder for {@link IProjectionStore}.
+ */
+
+export abstract class IProjectionStoreBuilder {
+    /**
+     * Build an {@link IProjectionStore} for the given tenant.
+     * @param { TenantIdLike } tenantId The tenant id.
+     * @returns {IProjectionStore} The projection store.
+     */
+    abstract forTenant(tenantId: TenantIdLike): IProjectionStore;
+}
diff --git a/Source/projections/Store/Builder/ProjectionStoreBuilder.ts b/Source/projections/Store/Builder/ProjectionStoreBuilder.ts
@@ -3,31 +3,36 @@
 
 import { Logger } from 'winston';
 
-import { ExecutionContext, TenantId } from '@dolittle/sdk.execution';
+import { ExecutionContext, TenantIdLike } from '@dolittle/sdk.execution';
 import { Guid } from '@dolittle/rudiments';
 
 import { ProjectionsClient } from '@dolittle/runtime.contracts/Projections/Store_grpc_pb';
 
 import { IProjectionAssociations, IProjectionStore, ProjectionStore } from '..';
+import { IProjectionStoreBuilder } from './IProjectionStoreBuilder';
 
 /**
- * Represents a builder for builing a projection store.
+ * Represents an implementation of {@link IProjectionsStoreBuilder}.
  */
-export class ProjectionStoreBuilder {
+export class ProjectionStoreBuilder extends IProjectionStoreBuilder {
 
+    /**
+     * Initializes a new instance of {@link ProjectionStoreBuilder}.
+     * @param {ProjectionsClient} projectionsClient The client for the projections.
+     * @param {ExecutionContext} executionContext The execution context.
+     * @param {IProjectionAssociations} projectionAssociations The projection associations.
+     * @param {Logger} logger The logger.
+     */
     constructor(
         private readonly _projectionsClient: ProjectionsClient,
         private readonly _executionContext: ExecutionContext,
         private readonly _projectionAssociations: IProjectionAssociations,
         private readonly _logger: Logger) {
+            super();
     }
 
-    /**
-     * Build an {@link IProjectionStore} for the given tenant.
-     * @param {TenantId | Guid | string} tenantId The tenant id.
-     * @returns {IProjectionStore} The projection store.
-     */
-    forTenant(tenantId: TenantId | Guid | string): IProjectionStore {
+    /** @inheritdoc */
+    forTenant(tenantId: TenantIdLike): IProjectionStore {
         const executionContext = this._executionContext
             .forTenant(tenantId)
             .forCorrelation(Guid.create());
diff --git a/Source/projections/Store/Builder/index.ts b/Source/projections/Store/Builder/index.ts
@@ -1,4 +1,5 @@
 // Copyright (c) Dolittle. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+export { IProjectionStoreBuilder } from './IProjectionStoreBuilder';
 export { ProjectionStoreBuilder } from './ProjectionStoreBuilder';
diff --git a/Source/projections/Store/index.ts b/Source/projections/Store/index.ts
diff --git a/Source/projections/index.ts b/Source/projections/index.ts
diff --git a/Source/sdk/DolittleClient.ts b/Source/sdk/DolittleClient.ts
diff --git a/Source/sdk/DolittleClientBuilder.ts b/Source/sdk/DolittleClientBuilder.ts
diff --git a/Source/sdk/EventStoreBuilderCallback.ts b/Source/sdk/EventStoreBuilderCallback.ts
diff --git a/Source/sdk/IDolittleClient.ts b/Source/sdk/IDolittleClient.ts
diff --git a/Source/sdk/index.ts b/Source/sdk/index.ts
