@looker/api-explorer 0.9.54 → 0.9.57

package/src/components/SideNav/SideNavTypeTags.spec.tsx

@@ -24,56 +24,56 @@
 
  */
 
-import React from 'react'
-import pick from 'lodash/pick'
-import { screen } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
+import React from 'react';
+import pick from 'lodash/pick';
+import { screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
 
-import { api } from '../../test-data'
-import { renderWithRouterAndReduxProvider } from '../../test-utils'
-import { SideNavTypeTags } from './SideNavTypeTags'
+import { api } from '../../test-data';
+import { renderWithRouterAndReduxProvider } from '../../test-utils';
+import { SideNavTypeTags } from './SideNavTypeTags';
 
 describe('SideNavTypeTags', () => {
-  const tags = pick(api.typeTags, ['ApiAuth', 'Dashboard'])
-  test('it renders a provided tag and its methods', () => {
+  const tags = pick(api.typeTags, ['ApiAuth', 'Dashboard']);
+  test('it renders a provided tag and its methods', async () => {
     renderWithRouterAndReduxProvider(
       <SideNavTypeTags tags={tags} specKey={'4.0'} />
-    )
-    const tag = screen.getByText('Dashboard')
-    const tagContent = 'CreateDashboardFilter'
-    expect(screen.queryByText(tagContent)).not.toBeInTheDocument()
-    userEvent.click(tag)
-    expect(screen.getByText(tagContent)).toBeInTheDocument()
-    const methods = screen.getAllByRole('link')
-    expect(methods).toHaveLength(Object.keys(tags.Dashboard).length)
-  })
+    );
+    const tag = screen.getByText('Dashboard');
+    const tagContent = 'CreateDashboardFilter';
+    expect(screen.queryByText(tagContent)).not.toBeInTheDocument();
+    await userEvent.click(tag);
+    expect(screen.getByText(tagContent)).toBeInTheDocument();
+    const methods = screen.getAllByRole('link');
+    expect(methods).toHaveLength(Object.keys(tags.Dashboard).length);
+  });
 
-  test('tags are rendered initially collapsed and expand when clicked', () => {
+  test('tags are rendered initially collapsed and expand when clicked', async () => {
     renderWithRouterAndReduxProvider(
       <SideNavTypeTags tags={tags} specKey={'4.0'} />
-    )
+    );
 
-    const allTags = screen.getAllByText(/ApiAuth|Dashboard/)
-    expect(allTags).toHaveLength(2)
-    expect(screen.queryByText('AccessToken')).not.toBeInTheDocument()
-    expect(screen.queryByText('CreateDashboardFilter')).not.toBeInTheDocument()
-    userEvent.click(allTags[0])
-    expect(screen.getByText('AccessToken')).toBeInTheDocument()
-    expect(screen.queryByText('CreateDashboardFilter')).not.toBeInTheDocument()
-  })
+    const allTags = screen.getAllByText(/ApiAuth|Dashboard/);
+    expect(allTags).toHaveLength(2);
+    expect(screen.queryByText('AccessToken')).not.toBeInTheDocument();
+    expect(screen.queryByText('CreateDashboardFilter')).not.toBeInTheDocument();
+    await userEvent.click(allTags[0]);
+    expect(screen.getByText('AccessToken')).toBeInTheDocument();
+    expect(screen.queryByText('CreateDashboardFilter')).not.toBeInTheDocument();
+  });
 
   test('tag is expanded if specified in route', () => {
-    const tags = pick(api.typeTags, ['ApiAuth', 'DataAction'])
+    const tags = pick(api.typeTags, ['ApiAuth', 'DataAction']);
     renderWithRouterAndReduxProvider(
       <SideNavTypeTags tags={tags} specKey={'4.0'} />,
       ['/4.0/types/DataAction']
-    )
+    );
 
-    const allTags = screen.getAllByText(/^(ApiAuth|DataAction)$/)
-    expect(allTags).toHaveLength(2)
-    expect(screen.queryByText('AccessToken')).not.toBeInTheDocument()
+    const allTags = screen.getAllByText(/^(ApiAuth|DataAction)$/);
+    expect(allTags).toHaveLength(2);
+    expect(screen.queryByText('AccessToken')).not.toBeInTheDocument();
     expect(screen.getAllByRole('link')).toHaveLength(
       Object.keys(tags.DataAction).length
-    )
-  })
-})
+    );
+  });
+});

package/src/components/SideNav/SideNavTypeTags.tsx

@@ -24,16 +24,16 @@
 
  */
 
-import React from 'react'
-import styled from 'styled-components'
-import type { TypeTagList } from '@looker/sdk-codegen'
-import { SideNavTypes } from './SideNavTypes'
+import React from 'react';
+import styled from 'styled-components';
+import type { TypeTagList } from '@looker/sdk-codegen';
+import { SideNavTypes } from './SideNavTypes';
 
 interface TypeTagsProps {
-  tags: TypeTagList
-  specKey: string
-  defaultOpen?: boolean
-  className?: string
+  tags: TypeTagList;
+  specKey: string;
+  defaultOpen?: boolean;
+  className?: string;
 }
 
 export const SideNavTypeTags = styled(
@@ -52,4 +52,4 @@ export const SideNavTypeTags = styled(
   )
 )`
   padding: 0 ${({ theme }) => theme.space.large};
-`
+`;

package/src/components/SideNav/SideNavTypes.spec.tsx

@@ -23,55 +23,55 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { screen } from '@testing-library/react'
+import React from 'react';
+import { screen } from '@testing-library/react';
 
-import userEvent from '@testing-library/user-event'
-import { api } from '../../test-data'
+import userEvent from '@testing-library/user-event';
+import { api } from '../../test-data';
 import {
   createTestStore,
   renderWithRouterAndReduxProvider,
-} from '../../test-utils'
-import { SideNavTypes } from './SideNavTypes'
+} from '../../test-utils';
+import { SideNavTypes } from './SideNavTypes';
 
-const mockHistoryPush = jest.fn()
+const mockHistoryPush = jest.fn();
 jest.mock('react-router-dom', () => {
-  const ReactRouterDOM = jest.requireActual('react-router-dom')
+  const ReactRouterDOM = jest.requireActual('react-router-dom');
   return {
     ...ReactRouterDOM,
     useHistory: () => ({
       push: mockHistoryPush,
       location: globalThis.location,
     }),
-  }
-})
+  };
+});
 
 describe('SideNavTypes', () => {
-  const tag = 'Dashboard'
-  const specKey = '4.0'
-  const typeTags = Object.keys(api.typeTags[tag])
+  const tag = 'Dashboard';
+  const specKey = '4.0';
+  const typeTags = Object.keys(api.typeTags[tag]);
 
   test('it renders provided types', () => {
     renderWithRouterAndReduxProvider(
       <SideNavTypes specKey={specKey} types={{ ...api.types }} tag={tag} />
-    )
-    expect(screen.getByRole('heading', { level: 4 })).toHaveTextContent(tag)
-  })
+    );
+    expect(screen.getByRole('heading', { level: 4 })).toHaveTextContent(tag);
+  });
 
-  test('tag expands and displays types after clicked', () => {
+  test('tag expands and displays types after clicked', async () => {
     renderWithRouterAndReduxProvider(
       <SideNavTypes types={{ ...api.types }} tag={tag} specKey={specKey} />
-    )
-    expect(screen.queryByText(typeTags[0])).not.toBeInTheDocument()
-    userEvent.click(screen.getByText(tag))
+    );
+    expect(screen.queryByText(typeTags[0])).not.toBeInTheDocument();
+    await userEvent.click(screen.getByText(tag));
     expect(mockHistoryPush).toHaveBeenCalledWith({
       pathname: `/${specKey}/types/${tag}`,
       search: '',
-    })
-    expect(screen.getByRole('link', { name: typeTags[0] })).toBeInTheDocument()
-  })
+    });
+    expect(screen.getByRole('link', { name: typeTags[0] })).toBeInTheDocument();
+  });
 
-  test('expanded tag closes when clicked', () => {
+  test('expanded tag closes when clicked', async () => {
     renderWithRouterAndReduxProvider(
       <SideNavTypes
         types={{ ...api.types }}
@@ -79,20 +79,20 @@ describe('SideNavTypes', () => {
         specKey={specKey}
         defaultOpen={true}
       />
-    )
-    expect(screen.getByRole('link', { name: typeTags[0] })).toBeInTheDocument()
-    userEvent.click(screen.getAllByText(tag)[0])
+    );
+    expect(screen.getByRole('link', { name: typeTags[0] })).toBeInTheDocument();
+    await userEvent.click(screen.getAllByText(tag)[0]);
     expect(mockHistoryPush).toHaveBeenCalledWith({
       pathname: `/${specKey}/types`,
       search: '',
-    })
+    });
     expect(
       screen.queryByRole('link', { name: typeTags[0] })
-    ).not.toBeInTheDocument()
-  })
+    ).not.toBeInTheDocument();
+  });
 
   test('it highlights text matching search pattern', () => {
-    const store = createTestStore({ settings: { searchPattern: 'dash' } })
+    const store = createTestStore({ settings: { searchPattern: 'dash' } });
     renderWithRouterAndReduxProvider(
       <SideNavTypes
         specKey={specKey}
@@ -103,8 +103,8 @@ describe('SideNavTypes', () => {
       />,
       undefined,
       store
-    )
-    const match = screen.getByText(/dash/i)
-    expect(match).toContainHTML('<span class="hi">Dash</span>')
-  })
-})
+    );
+    const match = screen.getByText(/dash/i);
+    expect(match).toContainHTML('<span class="hi">Dash</span>');
+  });
+});

package/src/components/SideNav/SideNavTypes.tsx

@@ -24,48 +24,48 @@
 
  */
 
-import React, { useEffect, useState } from 'react'
-import styled from 'styled-components'
-import { Accordion2, Heading } from '@looker/components'
-import type { TypeList } from '@looker/sdk-codegen'
-import { useRouteMatch } from 'react-router-dom'
-import { useSelector } from 'react-redux'
-import { Link } from '../Link'
-import { highlightHTML, useNavigation, buildTypePath } from '../../utils'
-import { selectSearchPattern } from '../../state'
+import React, { useEffect, useState } from 'react';
+import styled from 'styled-components';
+import { Accordion2, Heading } from '@looker/components';
+import type { TypeList } from '@looker/sdk-codegen';
+import { useRouteMatch } from 'react-router-dom';
+import { useSelector } from 'react-redux';
+import { Link } from '../Link';
+import { buildTypePath, highlightHTML, useNavigation } from '../../utils';
+import { selectSearchPattern } from '../../state';
 
 interface TypesProps {
-  types: TypeList
-  tag: string
-  specKey: string
-  className?: string
-  defaultOpen?: boolean
+  types: TypeList;
+  tag: string;
+  specKey: string;
+  className?: string;
+  defaultOpen?: boolean;
 }
 
 export const SideNavTypes = styled(
   ({ className, types, tag, specKey, defaultOpen = false }: TypesProps) => {
-    const { navigate, buildPathWithGlobalParams } = useNavigation()
-    const searchPattern = useSelector(selectSearchPattern)
+    const { navigate, buildPathWithGlobalParams } = useNavigation();
+    const searchPattern = useSelector(selectSearchPattern);
     const match = useRouteMatch<{ typeTag: string }>(
       `/:specKey/types/:typeTag/:typeName?`
-    )
-    const [isOpen, setIsOpen] = useState(defaultOpen)
+    );
+    const [isOpen, setIsOpen] = useState(defaultOpen);
     const handleOpen = () => {
-      const _isOpen = !isOpen
-      setIsOpen(_isOpen)
+      const _isOpen = !isOpen;
+      setIsOpen(_isOpen);
       if (_isOpen) {
-        navigate(`/${specKey}/types/${tag}`)
+        navigate(`/${specKey}/types/${tag}`);
       } else {
-        navigate(`/${specKey}/types`)
+        navigate(`/${specKey}/types`);
       }
-    }
+    };
 
     useEffect(() => {
       const status = match
         ? defaultOpen || match.params.typeTag === tag
-        : defaultOpen
-      setIsOpen(status)
-    }, [defaultOpen])
+        : defaultOpen;
+      setIsOpen(status);
+    }, [defaultOpen]);
 
     /* TODO: Fix highlighting. It is applied but it is somehow being overridden */
     return (
@@ -93,7 +93,7 @@ export const SideNavTypes = styled(
           ))}
         </ul>
       </Accordion2>
-    )
+    );
   }
 )`
   font-family: ${({ theme }) => theme.fonts.brand};
@@ -138,4 +138,4 @@ export const SideNavTypes = styled(
       background: ${({ theme }) => theme.colors.ui1};
     }
   }
-`
+`;

package/src/components/SideNav/index.ts

@@ -23,4 +23,4 @@
  SOFTWARE.
 
  */
-export { SideNav } from './SideNav'
+export { SideNav } from './SideNav';

package/src/components/SideNav/searchUtils.ts

@@ -24,30 +24,30 @@
 
  */
 
-import { useState, useEffect } from 'react'
-import type { TagList, TypeList } from '@looker/sdk-codegen'
+import { useEffect, useState } from 'react';
+import type { TagList, TypeList } from '@looker/sdk-codegen';
 
 export const useDebounce = <T>(value: T, delay: number): T => {
-  const [debouncedValue, setDebouncedValue] = useState(value)
+  const [debouncedValue, setDebouncedValue] = useState(value);
   useEffect(() => {
     // Update debounced value only once delay has been elapsed
     const handler = setTimeout(() => {
-      setDebouncedValue(value)
-    }, delay)
+      setDebouncedValue(value);
+    }, delay);
     // Reset the timeout on receiving a new keyword
     return () => {
-      clearTimeout(handler)
-    }
-  }, [value])
-  return debouncedValue
-}
+      clearTimeout(handler);
+    };
+  }, [value]);
+  return debouncedValue;
+};
 
 export const countMethods = (tags: TagList) => {
-  let result = 0
+  let result = 0;
   Object.values(tags).forEach((methods) => {
-    result += Object.entries(methods).length
-  })
-  return result
-}
+    result += Object.entries(methods).length;
+  });
+  return result;
+};
 
-export const countTypes = (types: TypeList) => Object.entries(types).length
+export const countTypes = (types: TypeList) => Object.entries(types).length;

package/src/components/common/Loader.tsx

@@ -23,20 +23,20 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
+import type { FC } from 'react';
+import React from 'react';
 import {
   ComponentsProvider,
   Flex,
   FlexItem,
   Heading,
   ProgressCircular,
-} from '@looker/components'
-import type { ThemeOverrides } from '@looker/extension-utils'
+} from '@looker/components';
+import type { ThemeOverrides } from '@looker/extension-utils';
 
 export interface LoaderProps {
-  themeOverrides: ThemeOverrides
-  message?: string
+  themeOverrides: ThemeOverrides;
+  message?: string;
 }
 
 export const Loader: FC<LoaderProps> = ({
@@ -55,4 +55,4 @@ export const Loader: FC<LoaderProps> = ({
       </FlexItem>
     </Flex>
   </ComponentsProvider>
-)
+);

package/src/components/common/common.tsx

@@ -23,25 +23,25 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React, { useEffect } from 'react'
-import type { SectionProps } from '@looker/components'
-import { Section } from '@looker/components'
-import { useWindowSize } from '../../utils'
-import { HEADER_REM } from '../Header'
+import type { FC } from 'react';
+import React, { useEffect } from 'react';
+import type { SectionProps } from '@looker/components';
+import { Section } from '@looker/components';
+import { useWindowSize } from '../../utils';
+import { HEADER_REM } from '../Header';
 
-export const REM_TO_PX = 16
+export const REM_TO_PX = 16;
 
 /**
  * Extends the looker Section to proper height and scrolls to top on use
  * @param props - anything you want, but probably SectionProps
  */
 export const ApixSection: FC<SectionProps> = (props: any) => {
-  const size = useWindowSize()
-  const sectionH = size.height - REM_TO_PX * HEADER_REM
+  const size = useWindowSize();
+  const sectionH = size.height - REM_TO_PX * HEADER_REM;
   useEffect(() => {
-    document.getElementById('top')?.scrollTo(REM_TO_PX * HEADER_REM, 0)
-  }, [props])
+    document.getElementById('top')?.scrollTo(REM_TO_PX * HEADER_REM, 0);
+  }, [props]);
 
   return (
     <Section
@@ -50,5 +50,5 @@ export const ApixSection: FC<SectionProps> = (props: any) => {
       p="xxlarge"
       style={{ height: `${sectionH}px`, overflow: 'auto', borderTop: '0px' }}
     />
-  )
-}
+  );
+};

package/src/components/common/index.ts

@@ -23,5 +23,5 @@
  SOFTWARE.
 
  */
-export * from './common'
-export * from './Loader'
+export * from './common';
+export * from './Loader';

package/src/components/index.ts

@@ -23,25 +23,25 @@
  SOFTWARE.
 
  */
-export { ApixSection, Loader } from './common'
-export { DocActivityType } from './DocActivityType'
-export { DocCode } from './DocCode'
-export { DocMethodSummary, DocSummaryStatus } from './DocMethodSummary'
-export { DocMarkdown } from './DocMarkdown'
-export { DocPseudo } from './DocPseudo'
-export { DocRateLimited } from './DocRateLimited'
-export { DocReferences } from './DocReferences'
-export { DocSDKs } from './DocSDKs'
-export { DocSdkUsage } from './DocSdkUsage'
-export { DocSource } from './DocSource'
-export { DocStatus } from './DocStatus'
-export { DocTitle } from './DocTitle'
-export { Header, HEADER_TOGGLE_LABEL } from './Header'
-export { SideNav } from './SideNav'
-export { ExploreType, ExploreProperty } from './ExploreType'
-export { DocSchema } from './DocSchema'
-export { DocTypeSummary } from './DocTypeSummary'
-export { Link } from './Link'
-export { ErrorBoundary } from './ErrorBoundary'
-export { SelectorContainer } from './SelectorContainer'
-export { Banner } from './Banner'
+export { ApixSection, Loader } from './common';
+export { DocActivityType } from './DocActivityType';
+export { DocCode } from './DocCode';
+export { DocMethodSummary, DocSummaryStatus } from './DocMethodSummary';
+export { DocMarkdown } from './DocMarkdown';
+export { DocPseudo } from './DocPseudo';
+export { DocRateLimited } from './DocRateLimited';
+export { DocReferences } from './DocReferences';
+export { DocSDKs } from './DocSDKs';
+export { DocSdkUsage } from './DocSdkUsage';
+export { DocSource } from './DocSource';
+export { DocStatus } from './DocStatus';
+export { DocTitle } from './DocTitle';
+export { Header, HEADER_TOGGLE_LABEL } from './Header';
+export { SideNav } from './SideNav';
+export { ExploreType, ExploreProperty } from './ExploreType';
+export { DocSchema } from './DocSchema';
+export { DocTypeSummary } from './DocTypeSummary';
+export { Link } from './Link';
+export { ErrorBoundary } from './ErrorBoundary';
+export { SelectorContainer } from './SelectorContainer';
+export { Banner } from './Banner';

package/src/custom.d.ts

@@ -1,4 +1,4 @@
 declare module '*.svg' {
-  const content: any
-  export default content
+  const content: any;
+  export default content;
 }

package/src/index.ts

@@ -23,8 +23,8 @@
  SOFTWARE.
 
  */
-export * from './ApiExplorer'
-export * from './StandaloneApiExplorer'
-export * from './components'
-export * from './state'
-export * from './utils'
+export * from './ApiExplorer';
+export * from './StandaloneApiExplorer';
+export * from './components';
+export * from './state';
+export * from './utils';

package/src/routes/AppRouter.tsx

@@ -24,10 +24,10 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import { Redirect, Route, Switch } from 'react-router-dom'
-import type { ApiModel } from '@looker/sdk-codegen'
+import type { FC } from 'react';
+import React from 'react';
+import { Redirect, Route, Switch } from 'react-router-dom';
+import type { ApiModel } from '@looker/sdk-codegen';
 
 import {
   ErrorDetailScene,
@@ -36,14 +36,14 @@ import {
   MethodTagScene,
   TypeScene,
   TypeTagScene,
-} from '../scenes'
-import { DiffScene } from '../scenes/DiffScene'
-import { diffPath } from '../utils'
+} from '../scenes';
+import { DiffScene } from '../scenes/DiffScene';
+import { diffPath } from '../utils';
 
 interface AppRouterProps {
-  specKey: string
-  api: ApiModel
-  toggleNavigation: (target?: boolean) => void
+  specKey: string;
+  api: ApiModel;
+  toggleNavigation: (target?: boolean) => void;
 }
 
 export const AppRouter: FC<AppRouterProps> = ({
@@ -75,4 +75,4 @@ export const AppRouter: FC<AppRouterProps> = ({
       <TypeScene api={api} />
     </Route>
   </Switch>
-)
+);

package/src/routes/index.ts

@@ -23,4 +23,4 @@
  SOFTWARE.
 
  */
-export { AppRouter } from './AppRouter'
+export { AppRouter } from './AppRouter';