@looker/api-explorer 0.9.54 → 0.9.57

package/src/components/DocMarkdown/DocMarkdown.spec.tsx

@@ -24,11 +24,11 @@
 
  */
 
-import React from 'react'
-import { screen } from '@testing-library/react'
-import { createTestStore, renderWithReduxProvider } from '../../test-utils'
+import React from 'react';
+import { screen } from '@testing-library/react';
+import { createTestStore, renderWithReduxProvider } from '../../test-utils';
 
-import { DocMarkdown } from './DocMarkdown'
+import { DocMarkdown } from './DocMarkdown';
 
 describe('DocMarkdown', () => {
   test('it renders markdown', () => {
@@ -39,27 +39,27 @@ describe('DocMarkdown', () => {
         }
         specKey={'4.0'}
       />
-    )
-    const heading = screen.getByRole('heading')
-    expect(heading).toHaveTextContent('Markdown Component')
-    const link = screen.getByRole('link')
-    expect(link).toHaveTextContent('ReactMarkdown')
+    );
+    const heading = screen.getByRole('heading');
+    expect(heading).toHaveTextContent('Markdown Component');
+    const link = screen.getByRole('link');
+    expect(link).toHaveTextContent('ReactMarkdown');
     expect(link).toHaveAttribute(
       'href',
       'https://github.com/rexxars/react-markdown'
-    )
-  })
+    );
+  });
 
   test('it remaps hashbang urls found in markdown input', () => {
     const input =
-      'A link to the [create_dashboard](#!/Dashboard/create_dashboard) endpoint'
-    renderWithReduxProvider(<DocMarkdown source={input} specKey={'4.0'} />)
-    expect(screen.getByText(/A link to the/)).toBeInTheDocument()
+      'A link to the [create_dashboard](#!/Dashboard/create_dashboard) endpoint';
+    renderWithReduxProvider(<DocMarkdown source={input} specKey={'4.0'} />);
+    expect(screen.getByText(/A link to the/)).toBeInTheDocument();
     expect(screen.getByText('create_dashboard')).toHaveAttribute(
       'href',
       '/4.0/methods/Dashboard/create_dashboard'
-    )
-  })
+    );
+  });
 
   test('it leaves external urls untouched', () => {
     renderWithReduxProvider(
@@ -67,34 +67,34 @@ describe('DocMarkdown', () => {
         source={'[external_link](https://www.foo.com)'}
         specKey={'4.0'}
       />
-    )
+    );
     expect(screen.getByText('external_link')).toHaveAttribute(
       'href',
       'https://www.foo.com'
-    )
-  })
+    );
+  });
 
   test('it highlights text matching search pattern', () => {
-    const highlightPattern = 'spec'
+    const highlightPattern = 'spec';
     const store = createTestStore({
       settings: { searchPattern: highlightPattern },
-    })
+    });
     renderWithReduxProvider(
       <DocMarkdown
         source={'An API Explorer to explore your OpenAPI spec'}
         specKey={'4.0'}
       />,
       store
-    )
-    const mark = screen.getByText(highlightPattern)
-    expect(mark.tagName).toEqual('MARK')
-  })
+    );
+    const mark = screen.getByText(highlightPattern);
+    expect(mark.tagName).toEqual('MARK');
+  });
 
   test('it only highlights search matches in the display text of link', () => {
-    const highlightPattern = 'dashboard'
+    const highlightPattern = 'dashboard';
     const store = createTestStore({
       settings: { searchPattern: highlightPattern },
-    })
+    });
     renderWithReduxProvider(
       <DocMarkdown
         source={
@@ -103,29 +103,29 @@ describe('DocMarkdown', () => {
         specKey={'4.0'}
       />,
       store
-    )
-    const link = screen.getByRole('link')
+    );
+    const link = screen.getByRole('link');
     expect(link).toHaveAttribute(
       'href',
       '/4.0/methods/Dashboard/create_dashboard'
-    )
-    expect(link).toContainHTML('create_<mark>dashboard</mark>')
-  })
+    );
+    expect(link).toContainHTML('create_<mark>dashboard</mark>');
+  });
 
   test('it renders code blocks', () => {
     const code =
-      '```\nAuthorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4\n```'
-    renderWithReduxProvider(<DocMarkdown source={code} specKey={'4.0'} />)
+      '```\nAuthorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4\n```';
+    renderWithReduxProvider(<DocMarkdown source={code} specKey={'4.0'} />);
     expect(
       screen.getByText(
         'Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4'
       )
-    ).toBeInTheDocument()
-  })
+    ).toBeInTheDocument();
+  });
 
   test('it renders inline code', () => {
-    const markdown = 'Some text with code: `const noop = () => null`'
-    renderWithReduxProvider(<DocMarkdown source={markdown} specKey={'4.0'} />)
-    expect(screen.getByText('const noop = () => null')).toBeInTheDocument()
-  })
-})
+    const markdown = 'Some text with code: `const noop = () => null`';
+    renderWithReduxProvider(<DocMarkdown source={markdown} specKey={'4.0'} />);
+    expect(screen.getByText('const noop = () => null')).toBeInTheDocument();
+  });
+});

package/src/components/DocMarkdown/DocMarkdown.tsx

@@ -24,34 +24,34 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import { Markdown } from '@looker/code-editor'
-import { useSelector } from 'react-redux'
-import { getEnvAdaptor } from '@looker/extension-utils'
-import { selectSearchPattern } from '../../state'
-import { useNavigation } from '../../utils'
-import { transformURL } from './utils'
+import type { FC } from 'react';
+import React from 'react';
+import { Markdown } from '@looker/code-editor';
+import { useSelector } from 'react-redux';
+import { getEnvAdaptor } from '@looker/extension-utils';
+import { selectSearchPattern } from '../../state';
+import { useNavigation } from '../../utils';
+import { transformURL } from './utils';
 
 interface DocMarkdownProps {
-  source: string
-  specKey: string
+  source: string;
+  specKey: string;
 }
 
 export const DocMarkdown: FC<DocMarkdownProps> = ({ source, specKey }) => {
-  const searchPattern = useSelector(selectSearchPattern)
-  const { navigate } = useNavigation()
+  const searchPattern = useSelector(selectSearchPattern);
+  const { navigate } = useNavigation();
 
   const linkClickHandler = (pathname: string, url: string) => {
     if (pathname.startsWith(`/${specKey}`)) {
-      navigate(pathname)
+      navigate(pathname);
     } else if (url.startsWith(`/${specKey}`)) {
-      navigate(url)
+      navigate(url);
     } else if (url.startsWith('https://')) {
-      const adaptor = getEnvAdaptor()
-      adaptor.openBrowserWindow(url)
+      const adaptor = getEnvAdaptor();
+      adaptor.openBrowserWindow(url);
     }
-  }
+  };
   return (
     <Markdown
       source={source}
@@ -59,5 +59,5 @@ export const DocMarkdown: FC<DocMarkdownProps> = ({ source, specKey }) => {
       linkClickHandler={linkClickHandler}
       transformLinkUri={transformURL.bind(null, specKey)}
     />
-  )
-}
+  );
+};

package/src/components/DocMarkdown/index.ts

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

package/src/components/DocMarkdown/utils.spec.ts

@@ -23,49 +23,49 @@
  SOFTWARE.
 
  */
-import { remapHashURL, transformURL } from './utils'
+import { remapHashURL, transformURL } from './utils';
 
 describe('DocMarkdown utils', () => {
   describe('hashbang url remapping', () => {
     test.each(['#!/methodTag', '#!/4.0/methodTag'])(
       'it correctly maps %s tag urls',
       (url) => {
-        const result = remapHashURL('4.0', url)
-        expect(result).toEqual('/4.0/methods/methodTag')
+        const result = remapHashURL('4.0', url);
+        expect(result).toEqual('/4.0/methods/methodTag');
       }
-    )
+    );
 
     test.each(['#!/4.0/methodTag/methodName', '#!/methodTag/methodName'])(
       'it correctly maps %s method urls ',
       (hashbangUrl) => {
-        const result = remapHashURL('4.0', hashbangUrl)
-        expect(result).toEqual('/4.0/methods/methodTag/methodName')
+        const result = remapHashURL('4.0', hashbangUrl);
+        expect(result).toEqual('/4.0/methods/methodTag/methodName');
       }
-    )
+    );
 
     test('external urls are left untouched', () => {
-      const url = 'https://foo.com'
-      const result = remapHashURL('4.0', url)
-      expect(result).toEqual(url)
-    })
-  })
+      const url = 'https://foo.com';
+      const result = remapHashURL('4.0', url);
+      expect(result).toEqual(url);
+    });
+  });
 
   describe('url transforming', () => {
     test('removes mark tags and transforms url', () => {
-      const url = '#!/<mark>Dashboard</mark>/create_<mark>dashboard</mark>'
-      const result = transformURL('4.0', url)
-      expect(result).toEqual('/4.0/methods/Dashboard/create_dashboard')
-    })
+      const url = '#!/<mark>Dashboard</mark>/create_<mark>dashboard</mark>';
+      const result = transformURL('4.0', url);
+      expect(result).toEqual('/4.0/methods/Dashboard/create_dashboard');
+    });
     test('removes mark tags and transforms url', () => {
-      const url = 'https://docs.looker.com/r/api/<mark>authorization</mark>'
-      const result = transformURL('4.0', url)
-      expect(result).toEqual('https://docs.looker.com/r/api/authorization')
-    })
+      const url = 'https://docs.looker.com/r/api/<mark>authorization</mark>';
+      const result = transformURL('4.0', url);
+      expect(result).toEqual('https://docs.looker.com/r/api/authorization');
+    });
     test('removes escaped mark tags and transforms url', () => {
       const url =
-        'https://docs.looker.com/r/api/%3Cmark%3Eauthorization%3Cmark%3E'
-      const result = transformURL('4.0', url)
-      expect(result).toEqual('https://docs.looker.com/r/api/authorization')
-    })
-  })
-})
+        'https://docs.looker.com/r/api/%3Cmark%3Eauthorization%3Cmark%3E';
+      const result = transformURL('4.0', url);
+      expect(result).toEqual('https://docs.looker.com/r/api/authorization');
+    });
+  });
+});

package/src/components/DocMarkdown/utils.ts

@@ -34,7 +34,7 @@ const cleanURL = (url: string) =>
     .replace(/<mark>/gi, '')
     .replace(/<\/mark>/gi, '')
     .replace(/%3Cmark%3E/gi, '')
-    .replace(/%3C\/mark%3E/gi, '')
+    .replace(/%3C\/mark%3E/gi, '');
 
 /**
  * Remaps tag/method a hashbang url to match the MethodScene route.
@@ -47,7 +47,7 @@ export const remapHashURL = (specKey: string, url: string) =>
     // #!/:navVersion?/:methodTag/:methodName
     .replace(/#!\/(:?\d+\.\d+\/)?(\w+)\/(\w+)/gi, `/${specKey}/methods/$2/$3`)
     // #!/:navVersion/:methodTag
-    .replace(/#!\/(:?\d+\.\d+\/)?(\w+)/gi, `/${specKey}/methods/$2`)
+    .replace(/#!\/(:?\d+\.\d+\/)?(\w+)/gi, `/${specKey}/methods/$2`);
 
 /**
  * Clean urls from mark tags and remap tag/method hashbang urls to match the MethodScene route
@@ -56,5 +56,5 @@ export const remapHashURL = (specKey: string, url: string) =>
  * Returns transformed url
  */
 export const transformURL = (specKey: string, url: string) => {
-  return remapHashURL(specKey, cleanURL(url))
-}
+  return remapHashURL(specKey, cleanURL(url));
+};

package/src/components/DocMethodSummary/DocMethodSummary.spec.tsx

@@ -23,29 +23,30 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { renderWithTheme } from '@looker/components-test-utils'
-import { screen, fireEvent, waitFor } from '@testing-library/react'
+import React from 'react';
+import { renderWithTheme } from '@looker/components-test-utils';
+import { fireEvent, screen, waitFor } from '@testing-library/react';
 
-import { api } from '../../test-data'
-import { DocMethodSummary } from './DocMethodSummary'
+import { api } from '../../test-data';
+import { DocMethodSummary } from './DocMethodSummary';
 
 describe('DocMethodSummary', () => {
   test('it renders a method summary', async () => {
-    const method = api.methods.run_inline_query
-    renderWithTheme(<DocMethodSummary method={method} />)
+    const method = api.methods.run_inline_query;
+    renderWithTheme(<DocMethodSummary method={method} />);
     expect(
       screen.getByText(method.httpMethod.toLocaleUpperCase())
-    ).toBeInTheDocument()
-    expect(screen.getByText(method.summary)).toBeInTheDocument()
-    expect(screen.getByText(method.endpoint)).toBeInTheDocument()
+    ).toBeInTheDocument();
+    expect(screen.getByText(method.summary)).toBeInTheDocument();
+    expect(screen.getByText(method.endpoint)).toBeInTheDocument();
     await waitFor(() => {
-      const statusIcon = screen.getByLabelText('stable item')
-      fireEvent.mouseOver(statusIcon)
+      const statusIcon = screen.getByLabelText('stable item');
+      // eslint-disable-next-line testing-library/no-wait-for-side-effects
+      fireEvent.mouseOver(statusIcon);
       expect(screen.getByRole('tooltip')).toHaveTextContent(
         'This item is considered stable for this API version.'
-      )
-    })
-    expect(screen.getByText('db_query')).toBeInTheDocument()
-  })
-})
+      );
+    });
+    expect(screen.getByText('db_query')).toBeInTheDocument();
+  });
+});

package/src/components/DocMethodSummary/DocMethodSummary.tsx

@@ -23,16 +23,16 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import { Card, CardContent, Flex, Space, Text } from '@looker/components'
-import type { IMethod } from '@looker/sdk-codegen'
-import { MethodBadge, RunItHeading } from '@looker/run-it'
-import { DocActivityType, DocRateLimited } from '../../components'
-import { DocSummaryStatus } from './DocSummaryStatus'
+import type { FC } from 'react';
+import React from 'react';
+import { Card, CardContent, Flex, Space, Text } from '@looker/components';
+import type { IMethod } from '@looker/sdk-codegen';
+import { MethodBadge, RunItHeading } from '@looker/run-it';
+import { DocActivityType, DocRateLimited } from '../../components';
+import { DocSummaryStatus } from './DocSummaryStatus';
 
 interface DocMethodSummaryProps {
-  method: IMethod
+  method: IMethod;
 }
 
 export const DocMethodSummary: FC<DocMethodSummaryProps> = ({ method }) => (
@@ -60,4 +60,4 @@ export const DocMethodSummary: FC<DocMethodSummaryProps> = ({ method }) => (
       </Space>
     </CardContent>
   </Card>
-)
+);

package/src/components/DocMethodSummary/DocSummaryStatus.spec.tsx

@@ -23,12 +23,12 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { renderWithTheme } from '@looker/components-test-utils'
-import { screen, waitFor, fireEvent } from '@testing-library/react'
+import React from 'react';
+import { renderWithTheme } from '@looker/components-test-utils';
+import { fireEvent, screen, waitFor } from '@testing-library/react';
 
-import { api, api40 } from '../../test-data'
-import { DocSummaryStatus } from './DocSummaryStatus'
+import { api, api40 } from '../../test-data';
+import { DocSummaryStatus } from './DocSummaryStatus';
 
 describe('DocMethodSummaryStatus', () => {
   test.each`
@@ -39,12 +39,12 @@ describe('DocMethodSummaryStatus', () => {
   `(
     'it renders an icon with a tooltip containing the right content for $status endpoints',
     async ({ method, expectedLabel, expectedContent }) => {
-      renderWithTheme(<DocSummaryStatus status={method.status} />)
-      const icon = screen.getByLabelText(expectedLabel)
-      fireEvent.mouseOver(icon)
+      renderWithTheme(<DocSummaryStatus status={method.status} />);
+      const icon = screen.getByLabelText(expectedLabel);
+      fireEvent.mouseOver(icon);
       await waitFor(() => {
-        expect(screen.getByRole('tooltip')).toHaveTextContent(expectedContent)
-      })
+        expect(screen.getByRole('tooltip')).toHaveTextContent(expectedContent);
+      });
     }
-  )
-})
+  );
+});

package/src/components/DocMethodSummary/DocSummaryStatus.tsx

@@ -23,16 +23,16 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import { Tooltip } from '@looker/components'
+import type { FC } from 'react';
+import React from 'react';
+import { Tooltip } from '@looker/components';
 
-import { pickStatus, pickTooltipContent } from './utils'
+import { pickStatus, pickTooltipContent } from './utils';
 
 interface DocSummaryStatusProps {
-  status: string
+  status: string;
 }
 
 export const DocSummaryStatus: FC<DocSummaryStatusProps> = ({ status }) => (
   <Tooltip content={pickTooltipContent(status)}>{pickStatus(status)}</Tooltip>
-)
+);

package/src/components/DocMethodSummary/index.tsx

@@ -23,6 +23,6 @@
  SOFTWARE.
 
  */
-export { DocMethodSummary } from './DocMethodSummary'
-export { DocSummaryStatus } from './DocSummaryStatus'
-export { pickTooltipContent } from './utils'
+export { DocMethodSummary } from './DocMethodSummary';
+export { DocSummaryStatus } from './DocSummaryStatus';
+export { pickTooltipContent } from './utils';

package/src/components/DocMethodSummary/utils.spec.tsx

@@ -23,7 +23,7 @@
  SOFTWARE.
 
  */
-import { pickTooltipContent } from './utils'
+import { pickTooltipContent } from './utils';
 
 describe('DocMethodSummary utils', () => {
   test.each`
@@ -38,8 +38,8 @@ describe('DocMethodSummary utils', () => {
   `(
     'pickTooltipContent returns correct $status item tooltip content',
     ({ status, expected }) => {
-      const actual = pickTooltipContent(status)
-      expect(actual).toEqual(expected)
+      const actual = pickTooltipContent(status);
+      expect(actual).toEqual(expected);
     }
-  )
-})
+  );
+});

package/src/components/DocMethodSummary/utils.tsx

@@ -23,34 +23,34 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import styled from 'styled-components'
-import { Icon, Status } from '@looker/components'
-import { Beaker } from '@looker/icons'
-import { VisibilityOff } from '@styled-icons/material/VisibilityOff'
+import React from 'react';
+import styled from 'styled-components';
+import { Icon, Status } from '@looker/components';
+import { Beaker } from '@looker/icons';
+import { VisibilityOff } from '@styled-icons/material/VisibilityOff';
 
 /**
  * Return a Status react element based on an endpoint's status
  * @param status Endpoint status
  */
 export const pickStatus = (status: string) => {
-  const title = `${status.toLowerCase()} item`
+  const title = `${status.toLowerCase()} item`;
   switch (status.toLowerCase()) {
     case 'beta':
-      return <StatusBeta aria-label={title}>&beta;</StatusBeta>
+      return <StatusBeta aria-label={title}>&beta;</StatusBeta>;
     case 'experimental': {
-      return <Icon title={title} aria-label={title} icon={<Beaker />} />
+      return <Icon title={title} aria-label={title} icon={<Beaker />} />;
     }
     case 'alpha': {
-      return <Icon title={title} aria-label={title} icon={<Beaker />} />
+      return <Icon title={title} aria-label={title} icon={<Beaker />} />;
     }
     case 'undocumented': {
-      return <Icon title={title} aria-label={title} icon={<VisibilityOff />} />
+      return <Icon title={title} aria-label={title} icon={<VisibilityOff />} />;
     }
     case 'deprecated':
-      return <Status aria-label={title} intent="critical" size="small" />
+      return <Status aria-label={title} intent="critical" size="small" />;
     case 'stable':
-      return <Status aria-label={title} intent="positive" size="small" />
+      return <Status aria-label={title} intent="positive" size="small" />;
     default:
       return (
         <Status
@@ -58,9 +58,9 @@ export const pickStatus = (status: string) => {
           intent="neutral"
           size="small"
         />
-      )
+      );
   }
-}
+};
 
 /**
  * Returns tooltip content based on status
@@ -69,21 +69,21 @@ export const pickStatus = (status: string) => {
 export const pickTooltipContent = (status: string) => {
   switch (status.toLowerCase()) {
     case 'alpha':
-      return 'This alpha item is either for internal use, or not fully developed and may be significantly changed or completely removed in future releases.'
+      return 'This alpha item is either for internal use, or not fully developed and may be significantly changed or completely removed in future releases.';
     case 'beta':
-      return 'This beta item is under development and subject to change.'
+      return 'This beta item is under development and subject to change.';
     case 'experimental':
-      return 'This experimental item is not fully developed and may be significantly changed or completely removed in future releases.'
+      return 'This experimental item is not fully developed and may be significantly changed or completely removed in future releases.';
     case 'deprecated':
-      return 'This item has been deprecated and will be removed in the future.'
+      return 'This item has been deprecated and will be removed in the future.';
     case 'stable':
-      return 'This item is considered stable for this API version.'
+      return 'This item is considered stable for this API version.';
     case 'undocumented':
-      return 'This is an internal-only item.'
+      return 'This is an internal-only item.';
     default:
-      return 'This item has no status associated with it.'
+      return 'This item has no status associated with it.';
   }
-}
+};
 
 const StatusBeta = styled.div`
   display: flex;
@@ -93,4 +93,4 @@ const StatusBeta = styled.div`
   color: ${({ theme }) => theme.colors.neutral};
   width: 1.125rem;
   height: 1.125rem;
-`
+`;

package/src/components/DocPseudo/DocParam.spec.tsx

@@ -23,37 +23,37 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { renderWithTheme } from '@looker/components-test-utils'
-import { describeParam } from '@looker/sdk-codegen'
-import { screen, waitFor, fireEvent } from '@testing-library/react'
+import React from 'react';
+import { renderWithTheme } from '@looker/components-test-utils';
+import { describeParam } from '@looker/sdk-codegen';
+import { fireEvent, screen, waitFor } from '@testing-library/react';
 
-import { api } from '../../test-data'
-import { DocParam } from './DocParam'
+import { api } from '../../test-data';
+import { DocParam } from './DocParam';
 
 describe('DocParam', () => {
-  const allParams = api.methods.run_look.allParams
-  const optionalParam = allParams.filter((val) => !val.required)[0]
-  const requiredParam = allParams.filter((val) => val.required)[0]
+  const allParams = api.methods.run_look.allParams;
+  const optionalParam = allParams.filter((val) => !val.required)[0];
+  const requiredParam = allParams.filter((val) => val.required)[0];
 
   test('it renders', () => {
-    renderWithTheme(<DocParam parameter={requiredParam} />)
-    expect(screen.getByText(requiredParam.name)).toBeInTheDocument()
-  })
+    renderWithTheme(<DocParam parameter={requiredParam} />);
+    expect(screen.getByText(requiredParam.name)).toBeInTheDocument();
+  });
 
   test('it renders required params with a tooltip', async () => {
-    renderWithTheme(<DocParam parameter={requiredParam} />)
-    const arg = screen.getByText(requiredParam.name)
-    fireEvent.mouseOver(arg)
+    renderWithTheme(<DocParam parameter={requiredParam} />);
+    const arg = screen.getByText(requiredParam.name);
+    fireEvent.mouseOver(arg);
     await waitFor(() => {
       expect(screen.getByRole('tooltip')).toHaveTextContent(
         `${requiredParam.type.name} ${describeParam(requiredParam)}`
-      )
-    })
-  })
+      );
+    });
+  });
 
   test('optional params in square brackets', () => {
-    renderWithTheme(<DocParam parameter={optionalParam} />)
-    expect(screen.getByText(`[${optionalParam.name}]`)).toBeInTheDocument()
-  })
-})
+    renderWithTheme(<DocParam parameter={optionalParam} />);
+    expect(screen.getByText(`[${optionalParam.name}]`)).toBeInTheDocument();
+  });
+});