@dashboard-designer/ui 0.1.0 → 0.1.2

package/README.md

@@ -5,9 +5,19 @@ Embeddable React dashboard designer and viewer.
 ## Install
 
 ```bash
-pnpm add @dashboard-designer/ui @dashboard-designer/core
+npm install @dashboard-designer/ui @dashboard-designer/core react react-dom
+# or
+pnpm add @dashboard-designer/ui @dashboard-designer/core react react-dom
 ```
 
+Install from a local checkout (after `pnpm build` in the monorepo):
+
+```bash
+npm install /path/to/DashboardDesigner/packages/ui /path/to/DashboardDesigner/packages/core react react-dom
+```
+
+Both `@dashboard-designer/ui` and `@dashboard-designer/core` are required. Do not install only `ui` — it depends on `core`.
+
 ## Usage
 
 ```tsx

package/dist/index.d.ts

@@ -49,6 +49,9 @@ declare class DashboardApiClient {
     saveConnection(connection: ConnectionConfig): Promise<{
         connection: ConnectionConfig;
     }>;
+    deleteConnection(id: string): Promise<{
+        ok: boolean;
+    }>;
     testConnection(id: string): Promise<{
         ok: boolean;
     }>;
@@ -114,7 +117,27 @@ declare class DashboardApiClient {
     }): Promise<{
         user: User;
     }>;
+    emailStatus(): Promise<{
+        configured: boolean;
+    }>;
+    sendDashboardEmail(input: {
+        to: string | string[];
+        cc?: string | string[];
+        subject: string;
+        body?: string;
+        bodyHtml?: string;
+        dashboardTitle?: string;
+        attachment?: EmailFileAttachment;
+        extraAttachments?: EmailFileAttachment[];
+    }): Promise<{
+        ok: boolean;
+    }>;
 }
+type EmailFileAttachment = {
+    filename: string;
+    contentType: string;
+    contentBase64: string;
+};
 
 interface ChartRendererProps {
     widget: Widget;