Merge branch 'dev'

Author: ivan-gerasimov-1

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.0-alpha.3 (2020-10-21)
+
+### New Features & Enhancements
+- feat(\*) Implement "AtLeast" utility type
+- feat(\*) Implement "DataConnectors" API and types
+
 ## 0.1.0-alpha.2 (2020-10-11)
 
 ### New Features & Enhancements

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@connio/js-sdk",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.3",
   "description": "Connio JavaScript SDK",
   "main": "./src/index.ts",
   "repository": {

package.json

@@ -0,0 +1,93 @@
+import { IDataConnector } from '../entities';
+import {
+  IDeleteResponse,
+  IPaginatedResponse,
+  IRestClient,
+} from '../rest-client';
+import type { AtLeast } from '../utility-types';
+
+export interface IDataConnectors {
+  list<T extends IDataConnector>(appRef: string): Promise<T[]>;
+  delete(connectorId: string, appRef: string): Promise<IDeleteResponse>;
+  read<T extends IDataConnector>(
+    connectorId: string,
+    appRef: string,
+  ): Promise<T>;
+  create<T extends IDataConnector>(
+    newConnector: Partial<T>,
+    appRef: string,
+  ): Promise<T>;
+  update<T extends IDataConnector>(
+    entity: AtLeast<T, 'id'>,
+    appRef: string,
+  ): Promise<T>;
+}
+export interface IDataConnectorsOptions {
+  client: IRestClient;
+}
+
+export class DataConnectors implements IDataConnectors {
+  private readonly _client: IRestClient;
+
+  private readonly APPS_URL = '/apps';
+  private readonly DATA_CONNECTORS_URL = '/dataconnectors';
+
+  constructor(options: IDataConnectorsOptions) {
+    this._client = options.client;
+  }
+
+  private _makeBaseUrl(appRef: string) {
+    return `${this.APPS_URL}/${appRef}${this.DATA_CONNECTORS_URL}`;
+  }
+
+  private _makeEntityUrl(connectorId: string, appRef: string) {
+    return `${this._makeBaseUrl(appRef)}/${connectorId}`;
+  }
+
+  public async create<T extends IDataConnector>(
+    newConnector: Partial<T>,
+    appRef: string,
+  ): Promise<T> {
+    return await this._client.post(this._makeBaseUrl(appRef), newConnector);
+  }
+
+  public async read<T extends IDataConnector>(
+    connectorId: string,
+    appRef: string,
+  ): Promise<T> {
+    return await this._client.get<T>(this._makeEntityUrl(connectorId, appRef));
+  }
+
+  public async list<T extends IDataConnector>(appRef: string): Promise<T[]> {
+    let response = await this._client.get<IPaginatedResponse<T>>(
+      this._makeBaseUrl(appRef),
+    );
+
+    return response.results;
+  }
+
+  public async update<T extends IDataConnector>(
+    payload: AtLeast<T, 'id'>,
+    appRef: string,
+  ): Promise<T> {
+    return await this._client.put(
+      this._makeEntityUrl(payload.id, appRef),
+      payload,
+    );
+  }
+
+  public async delete(
+    connectorId: string,
+    appRef: string,
+  ): Promise<IDeleteResponse> {
+    let response: IDeleteResponse = await this._client.delete(
+      this._makeEntityUrl(connectorId, appRef),
+    );
+
+    if (response.nrOfItems === 0) {
+      return Promise.reject(response);
+    }
+
+    return response;
+  }
+}

src/data-connectors/data-connectors.ts

@@ -0,0 +1 @@
+export { DataConnectors, IDataConnectors } from './data-connectors';

src/data-connectors/index.ts

@@ -0,0 +1,3 @@
+export enum DataConnectorType {
+  Kafka = 'kafka',
+}

src/entities/data-connector-type.ts

@@ -0,0 +1,27 @@
+import { DataConnectorType } from './data-connector-type';
+
+export interface IDataConnector {
+  type: DataConnectorType;
+  id: string;
+  dataProcessingMethod?: string;
+  disabled: boolean;
+}
+
+export interface IKafkaDataConnector extends IDataConnector {
+  server: string;
+  port: number;
+  ssl: boolean;
+  sslConfig?: IDataConnectorSSLConfig;
+  topic: string;
+}
+
+export interface IDataConnectorSSLConfig {
+  server: {
+    certificate: string;
+  };
+  client: {
+    certificate: string;
+    key: string;
+    password?: string;
+  };
+}

src/entities/data-connector.ts

@@ -12,6 +12,12 @@ export { IAppProfile } from './app-profile';
 export { IAuthData } from './auth-data';
 export { ConnectionStatus } from './connection-status';
 export { ICredentials } from './credentials';
+export {
+  IDataConnector,
+  IDataConnectorSSLConfig,
+  IKafkaDataConnector,
+} from './data-connector';
+export { DataConnectorType } from './data-connector-type';
 export { IDevice } from './device';
 export { IDeviceProfile } from './device-profile';
 export { EntityStatus } from './entity-status';

src/entities/index.ts

@@ -3,6 +3,7 @@ export { AppProfiles, IAppProfiles } from './app-profiles';
 export { Apps, IApps } from './apps';
 export { Auth, IAuth } from './auth';
 export { ICredentialsStore } from './credentials';
+export { DataConnectors, IDataConnectors } from './data-connectors';
 export { DeviceProfiles, IDeviceProfiles } from './device-profiles';
 export { Devices, IDevices } from './devices';
 export { IDisposable } from './disposable';

src/index.ts

@@ -3,6 +3,7 @@ import { AppProfiles, IAppProfiles } from './app-profiles';
 import { Apps, IApps } from './apps';
 import { Auth, IAuth } from './auth';
 import { CredentialsStore, ICredentialsStore } from './credentials';
+import { DataConnectors, IDataConnectors } from './data-connectors';
 import { DeviceProfiles, IDeviceProfiles } from './device-profiles';
 import { Devices, IDevices } from './devices';
 import { IEnvConfig } from './entities';
@@ -20,6 +21,7 @@ export interface IPlatform {
   apps: IApps;
   appProfiles: IAppProfiles;
   apiClients: IApiClients;
+  dataConnectors: IDataConnectors;
 }
 
 let platform: IPlatform;
@@ -61,6 +63,9 @@ export async function bootstrap(env: IEnvConfig): Promise<IPlatform> {
     apiClients: new ApiClients({
       client: restClient,
     }),
+    dataConnectors: new DataConnectors({
+      client: restClient,
+    }),
   };
 
   return platform;

src/instance.ts

@@ -0,0 +1 @@
+export type AtLeast<T, K extends keyof T> = Partial<T> & Pick<T, K>;