Merge branch 'dev'

Author: ivan-gerasimov-1

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0-alpha.4 (2020-10-27)
+
+### New Features & Enhancements
+- feat(\*) Implement "Methods" API and types
+
 ## 0.1.0-alpha.3 (2020-10-21)
 
 ### New Features & Enhancements

package-lock.json

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

package.json

@@ -23,6 +23,7 @@ export { IDeviceProfile } from './device-profile';
 export { EntityStatus } from './entity-status';
 export { EntityType } from './entity-type';
 export { IEnvConfig } from './env-config';
+export { IMethod, IMethodImplementation, MethodLanguage } from './method';
 export { IBoundaries as IPropertyBoundaries, IProperty } from './property';
 export { PropertyType } from './property-type';
 export { PublishType } from './publish-type';

src/entities/index.ts

@@ -0,0 +1,21 @@
+import { AccessType } from './access-type';
+import { IBaseEntity } from './base';
+
+export enum MethodLanguage {
+  JavaScript = 'javascript',
+}
+
+export interface IMethodImplementation {
+  funcBody: string;
+  script: MethodLanguage;
+}
+
+export interface IMethod extends IBaseEntity {
+  readonly accountId: string;
+  readonly ownerId: string;
+  /** @deprecated */
+  friendlyName: string;
+  qualifiedName: string;
+  access: AccessType;
+  methodImpl: IMethodImplementation;
+}

src/entities/method.ts

@@ -7,4 +7,5 @@ export { DataConnectors, IDataConnectors } from './data-connectors';
 export { DeviceProfiles, IDeviceProfiles } from './device-profiles';
 export { Devices, IDevices } from './devices';
 export { IDisposable } from './disposable';
+export { IMethods, Methods } from './methods';
 export { RestClient } from './rest-client';

src/index.ts

@@ -7,6 +7,7 @@ import { DataConnectors, IDataConnectors } from './data-connectors';
 import { DeviceProfiles, IDeviceProfiles } from './device-profiles';
 import { Devices, IDevices } from './devices';
 import { IEnvConfig } from './entities';
+import { IMethods, Methods } from './methods';
 import { IProperties, Properties } from './properties';
 import { IRestClient, RestClient } from './rest-client';
 
@@ -22,6 +23,7 @@ export interface IPlatform {
   appProfiles: IAppProfiles;
   apiClients: IApiClients;
   dataConnectors: IDataConnectors;
+  methods: IMethods;
 }
 
 let platform: IPlatform;
@@ -66,6 +68,9 @@ export async function bootstrap(env: IEnvConfig): Promise<IPlatform> {
     dataConnectors: new DataConnectors({
       client: restClient,
     }),
+    methods: new Methods({
+      client: restClient,
+    }),
   };
 
   return platform;

src/instance.ts

@@ -0,0 +1 @@
+export { IMethods, Methods } from './methods';

src/methods/index.ts

@@ -0,0 +1,29 @@
+import {
+  AbstractEntityApi,
+  IAbstractEntityApi,
+  IAbstractEntityOptions,
+} from '../abstract-entity-api';
+import { IMethod } from '../entities';
+
+export interface IMethods extends IAbstractEntityApi<IMethod> {
+  makeQualifiedName(methodName: string, profileName: string): string;
+}
+export interface IMethodsOptions extends IAbstractEntityOptions {}
+
+export class Methods extends AbstractEntityApi<IMethod> implements IMethods {
+  private readonly QUALIFIED_NAME_SEPARATOR = '$';
+
+  protected BASE_URL = '/methods';
+
+  constructor(options: IMethodsOptions) {
+    super(options);
+  }
+
+  public async list({ ownerId }: { ownerId: string }): Promise<IMethod[]> {
+    return await super.list({ ownerId });
+  }
+
+  public makeQualifiedName(methodName: string, profileName: string): string {
+    return `${profileName}${this.QUALIFIED_NAME_SEPARATOR}${methodName}`;
+  }
+}