@enplug/sdk-dashboard - npm Package Compare versions

Comparing version 5.1.6 to 5.1.7

package.json

 {
   "name": "@enplug/sdk-dashboard",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "description": "Enplug Dashboard SDK",
@@ -59,3 +59,2 @@ "main": "./src/index.ts",
   "devDependencies": {
-    "@enplug/api-data-connector": "^1.0.5",
     "@enplug/scripts": "^1.9.9",
@@ -62,0 +61,0 @@ "@types/jasmine": "^3.5.0",

src/dashboard.ts

@@ -12,2 +12,4 @@ import {
   UploadedFileResult,
+  ApiDataConnectorOptions,
+  DataConnectionConfig,
   } from './external-types';
@@ -18,4 +20,2 @@ import { BridgeBase } from './bridge/bridge-base';
 
-import { ApiDataConnectorOptions, DataConnectionConfig } from '@enplug/api-data-connector';
-
 export class Dashboard {
@@ -382,2 +382,14 @@ /**
   /**
+   * Uses connect data interface to edit connection, returns connection configuration object
+   * @param {ApiDataConnectorOptions} options Api Data Connector configuration options
+   */
+  editConnection(configuration: DataConnectionConfig): Promise<DataConnectionConfig> {
+    return this.bridge.sendMessage({
+      namespace: MessageNamespaces.Dashboard,
+      name: MessageNames.ConnectData,
+      params: configuration,
+    });
+  }
+
+  /**
    * Creates new assets and begins encoding process
@@ -384,0 +396,0 @@ */

src/external-types.ts

@@ -213,4 +213,2 @@ /** These are meant to avaialable to client apps */
 
-export type BindingDataType = 'image' | 'date' | 'text';
-
 export interface UploadedFileResult extends FilepickerUploadedFile {
@@ -418,1 +416,55 @@ assetId?: string;
 export type Environment = 'staging' | 'dev' | 'production';
+
+export type ConnectionType = 'push' | 'pull';
+
+export interface BindingConfig {
+  dataPath: string;
+  bindingPairs: BindingPair[];
+  sampleData?: object;
+}
+
+export interface BindingPair {
+  column: string;
+  value: string;
+  type: BindingDataType;
+}
+
+export type BindingDataType = 'image' | 'date' | 'text';
+
+export interface PushConnectionConfig {
+  webURL: string;
+}
+
+export interface PullConnectionConfig {
+  webURL: string;
+  params: ConnectionQueryParams[];
+  headers: ConnectionHttpHeaders[];
+  refreshFrequency: RefreshFrequency;
+}
+
+interface ConnectionParams {
+  name: string;
+  value: string;
+  encrypt: boolean;
+}
+
+// tslint:disable: no-empty-interface
+export interface ConnectionQueryParams extends ConnectionParams {}
+export interface ConnectionHttpHeaders extends ConnectionParams {}
+
+export type RefreshFrequency = 1 | 3 | 5;
+
+export interface ApiDataItem {
+  name: string;
+  type: BindingDataType;
+}
+
+export interface ApiDataConnectorOptions {
+  apiDataItems: ApiDataItem[];
+}
+
+export interface DataConnectionConfig {
+  binding: BindingConfig;
+  connection: PushConnectionConfig | PullConnectionConfig;
+  type: ConnectionType;
+}

No alert changes

Improved metrics

Total package byte prevSize

196163

increased by1.34%

Dev dependency count

28

decreased by-3.45%

Lines of code

3098

increased by2.11%

No dependency changes