Formatting

VolkovLabs · Nov 14, 2024 · 2b79631 · 2b79631
1 parent 5c4d12a
commit 2b79631
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 74 deletions.
diff --git a/package.json b/package.json
@@ -74,10 +74,10 @@
     "start:main": "docker compose pull grafana-main && docker compose --profile main up",
     "stop": "docker compose down",
     "test": "jest --watch --onlyChanged",
+    "test:ci": "jest --maxWorkers 4 --coverage",
     "test:e2e": "npx playwright test",
     "test:e2e:dev": "npx playwright test --ui",
     "test:e2e:docker": "docker compose --profile e2e up --exit-code-from test",
-    "test:ci": "jest --maxWorkers 4 --coverage",
     "upgrade": "npm upgrade --save"
   },
   "version": "4.9.0"

diff --git a/src/components/FormPanel/FormPanel.test.tsx b/src/components/FormPanel/FormPanel.test.tsx
@@ -989,7 +989,7 @@ describe('Panel', () => {
                 initial: {
                   method: RequestMethod.NONE,
                   code: `
-                    const section = context.panel.sectionsUtils.get('section12'); context.grafana.notifySuccess(['Sections',section.id]);
+                    const section = context.panel.sectionsUtils.get('section12'); context.grafana.notifySuccess(['Sections', section]);
                   `,
                 },
                 layout: {
@@ -1005,7 +1005,7 @@ describe('Panel', () => {
 
         expect(appEventsMock.publish).toHaveBeenCalledWith({
           type: AppEvents.alertSuccess.name,
-          payload: ['Sections', null],
+          payload: ['Sections', undefined],
         });
       });
     });

diff --git a/src/hooks/useFormLayout.ts b/src/hooks/useFormLayout.ts
@@ -1,7 +1,7 @@
 import { EventBusSrv, SelectableValue } from '@grafana/data';
 import { useCallback, useEffect, useRef, useState } from 'react';
 
-import { FormElement, LayoutSection, LocalFormElement } from '../types';
+import { FormElement, LayoutSection, LayoutSectionWithElements, LocalFormElement } from '../types';
 import {
   convertElementsToPayload,
   isElementConflict,
@@ -323,17 +323,14 @@ export const useFormLayout = ({
    * Get Section
    */
   const getSection = useCallback(
-    (id: string) => {
+    (id: string): LayoutSectionWithElements | undefined => {
       const sections = sectionsRef.current;
       const section = sections.find((section) => section.id === id);
 
       if (!section) {
-        return {
-          id: null,
-          name: null,
-          elements: [],
-        };
+        return;
       }
+
       const currentElements = elementsRef.current;
       const sectionElements = currentElements.filter((curElement) => curElement.section === section.name);
       return {
@@ -347,10 +344,10 @@ export const useFormLayout = ({
   /**
    * Get Section
    */
-  const getAllSections = useCallback(() => {
+  const getAllSections = useCallback((): LayoutSectionWithElements[] => {
     const sections = sectionsRef.current;
 
-    return sections.map((section) => {
+    return sections.map((section): LayoutSectionWithElements => {
       const currentElements = elementsRef.current;
       const sectionElements = currentElements.filter((curElement) => curElement.section === section.name);
       return {

diff --git a/src/types/layout.ts b/src/types/layout.ts
@@ -1,4 +1,5 @@
-import { LayoutOrientation, LayoutVariant, SectionVariant } from '../constants';
+import { LayoutOrientation, LayoutVariant, SectionVariant } from '@/constants';
+import { LocalFormElement } from '@/types/form-element';
 
 /**
  * Layout Section
@@ -26,6 +27,11 @@ export interface LayoutSection {
   expanded?: boolean;
 }
 
+/**
+ * Layout Section With Elements
+ */
+export type LayoutSectionWithElements = LayoutSection & { elements: LocalFormElement[] };
+
 /**
  * Layout Options
  */

diff --git a/src/utils/code-parameters.ts b/src/utils/code-parameters.ts
@@ -3,9 +3,48 @@ import { BackendSrv, FetchResponse, LocationService, TemplateSrv, toDataQueryRes
 import { CodeEditorSuggestionItemKind } from '@grafana/ui';
 import { CodeParameterItem, CodeParametersBuilder } from '@volkovlabs/components';
 
-import { FormElement, LayoutSection, LocalFormElement, PanelOptions } from '../types';
+import { FormElement, LayoutSection, LayoutSectionWithElements, LocalFormElement, PanelOptions } from '@/types';
+
 import { fileToBase64 } from './request';
 
+/**
+ * Sections Utils
+ */
+const sectionsUtils = {
+  detail: 'Section Helpers',
+  items: {
+    add: new CodeParameterItem<({ name, id, elements }: { name: string; id: string; elements: string[] }) => void>(
+      'Add new Section',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    update: new CodeParameterItem<(sections: LayoutSection[]) => void>(
+      'Change sections',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    remove: new CodeParameterItem<(id: string) => void>('Remove section', CodeEditorSuggestionItemKind.Method),
+    assign: new CodeParameterItem<(id: string, elements: string[]) => void>(
+      'Assign elements to section',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    unassign: new CodeParameterItem<(elements: string[]) => void>(
+      'Unassign elements from section',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    get: new CodeParameterItem<(id: string) => LayoutSectionWithElements | undefined>(
+      'Get section',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    getAll: new CodeParameterItem<() => LayoutSectionWithElements[]>(
+      'Get all sections',
+      CodeEditorSuggestionItemKind.Method
+    ),
+    toggle: new CodeParameterItem<(id: string) => void>('Toggle section', CodeEditorSuggestionItemKind.Method),
+    collapse: new CodeParameterItem<(id: string) => void>('Collapse section', CodeEditorSuggestionItemKind.Method),
+    expand: new CodeParameterItem<(id: string) => void>('Expand section', CodeEditorSuggestionItemKind.Method),
+    expandedState: new CodeParameterItem<Record<string, boolean>>('Sections Expanded State'),
+  },
+};
+
 /**
  * Request Code Parameters
  */
@@ -52,36 +91,7 @@ export const requestCodeParameters = new CodeParametersBuilder({
         response: new CodeParameterItem<FetchResponse | Response | DataQueryResponse | null | undefined>(
           'Response object.'
         ),
-        sectionsUtils: {
-          detail: 'Section Helpers',
-          items: {
-            add: new CodeParameterItem<
-              ({ name, id, elements }: { name: string; id: string; elements: string[] }) => void
-            >('Add new Section', CodeEditorSuggestionItemKind.Method),
-            update: new CodeParameterItem<(sections: LayoutSection[]) => void>(
-              'Change sections',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            remove: new CodeParameterItem<(id: string) => void>('Remove section', CodeEditorSuggestionItemKind.Method),
-            assign: new CodeParameterItem<(id: string, elements: string[]) => void>(
-              'Assign elements to section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            unassign: new CodeParameterItem<(elements: string[]) => void>(
-              'Unassign elements from section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            get: new CodeParameterItem<(id: string) => void>('Get section', CodeEditorSuggestionItemKind.Method),
-            getAll: new CodeParameterItem<() => void>('Get all sections', CodeEditorSuggestionItemKind.Method),
-            toggle: new CodeParameterItem<(id: string) => void>('Toggle section', CodeEditorSuggestionItemKind.Method),
-            collapse: new CodeParameterItem<(id: string) => void>(
-              'Collapse section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            expand: new CodeParameterItem<(id: string) => void>('Expand section', CodeEditorSuggestionItemKind.Method),
-            expandedState: new CodeParameterItem<Record<string, boolean>>('Sections Expanded State'),
-          },
-        },
+        sectionsUtils,
       },
     },
     grafana: {
@@ -176,36 +186,7 @@ export const elementValueChangedCodeParameters = new CodeParametersBuilder({
           'Disable save default button.',
           CodeEditorSuggestionItemKind.Method
         ),
-        sectionsUtils: {
-          detail: 'Section Helpers',
-          items: {
-            add: new CodeParameterItem<
-              ({ name, id, elements }: { name: string; id: string; elements: string[] }) => void
-            >('Add new Section', CodeEditorSuggestionItemKind.Method),
-            update: new CodeParameterItem<(sections: LayoutSection[]) => void>(
-              'Change sections',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            remove: new CodeParameterItem<(id: string) => void>('Remove section', CodeEditorSuggestionItemKind.Method),
-            assign: new CodeParameterItem<(id: string, elements: string[]) => void>(
-              'Assign elements to section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            unassign: new CodeParameterItem<(elements: string[]) => void>(
-              'Unassign elements from section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            get: new CodeParameterItem<(id: string) => void>('Get section', CodeEditorSuggestionItemKind.Method),
-            getAll: new CodeParameterItem<() => void>('Get all sections', CodeEditorSuggestionItemKind.Method),
-            toggle: new CodeParameterItem<(id: string) => void>('Toggle section', CodeEditorSuggestionItemKind.Method),
-            collapse: new CodeParameterItem<(id: string) => void>(
-              'Collapse section',
-              CodeEditorSuggestionItemKind.Method
-            ),
-            expand: new CodeParameterItem<(id: string) => void>('Expand section', CodeEditorSuggestionItemKind.Method),
-            expandedState: new CodeParameterItem<Record<string, boolean>>('Sections Expanded State'),
-          },
-        },
+        sectionsUtils,
       },
     },
     grafana: {