semaphor 0.0.0 → 0.0.11

package/dist/react-semaphor.d.ts

@@ -10,6 +10,7 @@ declare type Actions = {
     setAuthToken: (authToken: AuthToken) => void;
     setThemeStyle: (themeStyle: StyleProps) => void;
     setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
+    setBookmarkKey: (bookmarkKey: string) => void;
     setDashboard: (dashboard: TDashboard) => void;
     setDashboardTheme: (theme: 'light' | 'dark' | 'system') => void;
     setDashboardTitle: (title: string) => void;
@@ -91,6 +92,7 @@ declare type DashboardStore = {
     authToken?: AuthToken;
     theme?: 'light' | 'dark' | 'system';
     themeStyle?: StyleProps;
+    bookmarkKey?: string;
     dashboard: TDashboard;
     selectedSheetId?: string | null | undefined;
     selectedCardId?: string | null;
@@ -109,6 +111,8 @@ declare type DashboardStore = {
     actions: Actions;
 };
 
+export declare const DashboardWC: CustomElementConstructor;
+
 export declare type ErrorProps = {
     message?: string;
 };
@@ -143,6 +147,8 @@ declare type FilterForString = BaseFilter & {
     values: [string];
 };
 
+export declare function getBookmarkKey(dashboardId: string): string;
+
 export declare function getDashbaordStateWithoutData(dashboardState: TDashboard): {
     sheets: {
         cards: TCard[] | undefined;
@@ -162,20 +168,30 @@ export declare type LoadingProps = {
     message?: string;
 };
 
+/**
+ * Style propeerites for the dashboard
+ */
 export declare type StyleProps = {
+    /** css class for `dashboard-panel` */
     dashboardPanel?: string;
+    /** css class for `dashboard-tabs-container` */
     dashboardTabsContainer?: string;
+    /** css class for `dashboard-card` */
+    /** css class for `dashboard-card-container` */
+    dashboardCardContainer?: string;
     dashboardCard?: string;
-    dashboardHeader?: string;
-    dashboardTitle?: string;
-    dashboardDescription?: string;
+    /** grid-layout config */
     gridLayout?: {
+        /** css class for `react-grid-layout` */
         className?: string;
         margin?: [number, number];
     };
+    /** chart config */
     chart?: {
+        /** chart font config */
         font?: Partial<FontSpec>;
         dataset?: any;
+        /** chart options */
         options?: any;
     };
 };
@@ -239,6 +255,9 @@ export declare type TSheet = {
     cards?: TCard[];
 };
 
+/**
+ * Style for the dashboard
+ */
 export declare type TStyle = {
     default: StyleProps;
     dark?: StyleProps;
@@ -264,10 +283,8 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
         themeStyle?: {
             dashboardPanel?: string | undefined;
             dashboardTabsContainer?: string | undefined;
+            dashboardCardContainer?: string | undefined;
             dashboardCard?: string | undefined;
-            dashboardHeader?: string | undefined;
-            dashboardTitle?: string | undefined;
-            dashboardDescription?: string | undefined;
             gridLayout?: {
                 className?: string | undefined;
                 margin?: [number, number] | undefined;
@@ -284,6 +301,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 options?: any;
             } | undefined;
         } | undefined;
+        bookmarkKey?: string | undefined;
         dashboard: {
             id: string;
             title?: string | undefined;
@@ -333,10 +351,8 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 default: {
                     dashboardPanel?: string | undefined;
                     dashboardTabsContainer?: string | undefined;
+                    dashboardCardContainer?: string | undefined;
                     dashboardCard?: string | undefined;
-                    dashboardHeader?: string | undefined;
-                    dashboardTitle?: string | undefined;
-                    dashboardDescription?: string | undefined;
                     gridLayout?: {
                         className?: string | undefined;
                         margin?: [number, number] | undefined;
@@ -356,10 +372,8 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 dark?: {
                     dashboardPanel?: string | undefined;
                     dashboardTabsContainer?: string | undefined;
+                    dashboardCardContainer?: string | undefined;
                     dashboardCard?: string | undefined;
-                    dashboardHeader?: string | undefined;
-                    dashboardTitle?: string | undefined;
-                    dashboardDescription?: string | undefined;
                     gridLayout?: {
                         className?: string | undefined;
                         margin?: [number, number] | undefined;
@@ -472,6 +486,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             setAuthToken: (authToken: AuthToken) => void;
             setThemeStyle: (themeStyle: StyleProps) => void;
             setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
+            setBookmarkKey: (bookmarkKey: string) => void;
             setDashboard: (dashboard: TDashboard) => void;
             setDashboardTheme: (theme: 'light' | 'dark' | 'system') => void;
             setDashboardTitle: (title: string) => void;