@devtable/dashboard 2.4.0 → 3.0.0

package/README.md

@@ -7,6 +7,30 @@ cd devtable/dashboard && yarn
 # 2. run demo
 cd devtable/dashboard/packages/core && yarn build
 ```
+
 see `package.json` for more scripts
 
-use `../demo` for debugging
+use `../demo` for debugging
+
+## Testing
+
+Use cypress for component testing.
+
+```shell
+$ nx cypress dashboard
+```
+
+Use vitest for other types of testing.
+
+```shell
+$ nx vitest dashboard
+```
+
+Use `-c ci` to run tests in headless mode.
+
+```shell
+$ nx cypress dashboard -c ci
+$ nx vitest dashboard -c ci
+# run both in parallel
+$ nx test dashboard -c ci
+```

package/dist/api-caller/index.d.ts

@@ -1,5 +1,7 @@
-import { ContextInfoContextType, FilterValuesContextType } from '../contexts';
-import { IDashboardDefinition, IQuery } from '../types';
+import { FilterValuesType } from '../model';
+import { ContextInfoType } from '../model/context';
+import { DataSourceType } from '../model/queries/types';
+import { SQLSnippetModelInstance } from '../model/sql-snippets';
 import { IDataSource } from './types';
 interface IQueryByStaticSQL {
     type: 'postgresql';
@@ -8,13 +10,17 @@ interface IQueryByStaticSQL {
 }
 export declare const queryByStaticSQL: ({ type, key, sql }: IQueryByStaticSQL) => () => Promise<any>;
 interface IQueryBySQL {
-    context: ContextInfoContextType;
-    definitions: IDashboardDefinition;
+    context: ContextInfoType;
+    sqlSnippets: SQLSnippetModelInstance[];
     title: string;
-    query?: IQuery;
-    filterValues: FilterValuesContextType;
+    query: {
+        type: DataSourceType;
+        key: string;
+        sql: string;
+    };
+    filterValues: FilterValuesType;
 }
-export declare const queryBySQL: ({ context, definitions, title, query, filterValues }: IQueryBySQL) => () => Promise<any>;
+export declare function queryBySQL({ context, sqlSnippets, title, query, filterValues }: IQueryBySQL): Promise<any>;
 export declare type TQuerySources = Record<string, string[]>;
 export declare function listDataSources(): Promise<IDataSource[]>;
 export {};

package/dist/api-caller/types.d.ts

@@ -1,9 +1,9 @@
+import { DataSourceType } from '../model/queries/types';
 export declare type PaginationResponse<T> = {
     total: number;
     offset: number;
     data: T[];
 };
-export declare type DataSourceType = 'postgresql' | 'mysql' | 'http';
 export interface IDataSource {
     id: string;
     type: DataSourceType;

package/dist/contexts/index.d.ts

@@ -1,5 +1,3 @@
-export * from './definition-context';
-export * from './context-info-context';
-export * from './filter-values-context';
+export * from './model-context';
 export * from './layout-state-context';
 export * from './panel-context';