@looker/api-explorer 0.9.55 → 0.9.57

package/src/components/DocPseudo/DocParam.tsx

@@ -23,18 +23,18 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import type { IParameter } from '@looker/sdk-codegen'
-import { Tooltip } from '@looker/components'
-import { describeParam } from '@looker/sdk-codegen'
+import type { FC } from 'react';
+import React from 'react';
+import type { IParameter } from '@looker/sdk-codegen';
+import { Tooltip } from '@looker/components';
+import { describeParam } from '@looker/sdk-codegen';
 
 export interface DocArgProps {
-  parameter: IParameter
+  parameter: IParameter;
 }
 
 export const DocParam: FC<DocArgProps> = ({ parameter }) => (
   <Tooltip content={`${parameter.type.name} ${describeParam(parameter)}`}>
     <span>{parameter.required ? parameter.name : `[${parameter.name}]`}</span>
   </Tooltip>
-)
+);

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

@@ -23,43 +23,43 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { screen } from '@testing-library/react'
-import { renderWithTheme } from '@looker/components-test-utils'
+import React from 'react';
+import { screen } from '@testing-library/react';
+import { renderWithTheme } from '@looker/components-test-utils';
 
-import { api } from '../../test-data'
-import { DocParams } from './DocParams'
+import { api } from '../../test-data';
+import { DocParams } from './DocParams';
 
 describe('DocParams', () => {
   test('it works when method only has required params', () => {
-    const params = api.methods.create_connection.allParams
-    expect(params).toHaveLength(1)
+    const params = api.methods.create_connection.allParams;
+    expect(params).toHaveLength(1);
     // eslint-disable-next-line jest-dom/prefer-required
-    expect(params[0]).toHaveProperty('required', true)
+    expect(params[0]).toHaveProperty('required', true);
 
-    renderWithTheme(<DocParams parameters={params} />)
-    expect(screen.getByText(params[0].name)).toBeInTheDocument()
-  })
+    renderWithTheme(<DocParams parameters={params} />);
+    expect(screen.getByText(params[0].name)).toBeInTheDocument();
+  });
 
   test('it works when method only has optional params', () => {
-    const params = api.methods.me.allParams
-    expect(params).toHaveLength(1)
+    const params = api.methods.me.allParams;
+    expect(params).toHaveLength(1);
     // eslint-disable-next-line jest-dom/prefer-required
-    expect(params[0]).toHaveProperty('required', false)
+    expect(params[0]).toHaveProperty('required', false);
 
-    renderWithTheme(<DocParams parameters={params} />)
-    expect(screen.getByText(`[${params[0].name}]`)).toBeInTheDocument()
-  })
+    renderWithTheme(<DocParams parameters={params} />);
+    expect(screen.getByText(`[${params[0].name}]`)).toBeInTheDocument();
+  });
 
   test('it works when method has both required and optional params', () => {
-    const params = api.methods.user.allParams
-    const requiredParams = params.filter((param) => param.required)
-    const optionalParams = params.filter((param) => !param.required)
-    expect(requiredParams).toHaveLength(1)
-    expect(optionalParams).toHaveLength(1)
+    const params = api.methods.user.allParams;
+    const requiredParams = params.filter((param) => param.required);
+    const optionalParams = params.filter((param) => !param.required);
+    expect(requiredParams).toHaveLength(1);
+    expect(optionalParams).toHaveLength(1);
 
-    renderWithTheme(<DocParams parameters={params} />)
-    expect(screen.getByText(requiredParams[0].name)).toBeInTheDocument()
-    expect(screen.getByText(`[${optionalParams[0].name}]`)).toBeInTheDocument()
-  })
-})
+    renderWithTheme(<DocParams parameters={params} />);
+    expect(screen.getByText(requiredParams[0].name)).toBeInTheDocument();
+    expect(screen.getByText(`[${optionalParams[0].name}]`)).toBeInTheDocument();
+  });
+});

package/src/components/DocPseudo/DocParams.tsx

@@ -23,14 +23,14 @@
  SOFTWARE.
 
  */
-import type { IParameter } from '@looker/sdk-codegen'
-import type { FC } from 'react'
-import React, { Fragment } from 'react'
+import type { IParameter } from '@looker/sdk-codegen';
+import type { FC } from 'react';
+import React, { Fragment } from 'react';
 
-import { DocParam } from './DocParam'
+import { DocParam } from './DocParam';
 
 export interface DocArgsProps {
-  parameters: IParameter[]
+  parameters: IParameter[];
 }
 
 export const DocParams: FC<DocArgsProps> = ({ parameters }) => (
@@ -42,4 +42,4 @@ export const DocParams: FC<DocArgsProps> = ({ parameters }) => (
       </Fragment>
     ))}
   </>
-)
+);

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

@@ -23,30 +23,30 @@
  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 } from '../../test-data'
-import { DocPrimaryResponse } from './DocPrimaryResponse'
+import { api } from '../../test-data';
+import { DocPrimaryResponse } from './DocPrimaryResponse';
 
 describe('DocPrimaryResponse', () => {
-  const response = api.methods.create_query.primaryResponse
+  const response = api.methods.create_query.primaryResponse;
 
   test('it renders response type name', () => {
-    renderWithTheme(<DocPrimaryResponse response={response} />)
-    expect(screen.getByText(response.type.name)).toBeInTheDocument()
-  })
+    renderWithTheme(<DocPrimaryResponse response={response} />);
+    expect(screen.getByText(response.type.name)).toBeInTheDocument();
+  });
 
   test('it renders a tooltip on mouse over', async () => {
-    renderWithTheme(<DocPrimaryResponse response={response} />)
-    const resp = screen.getByText(response.type.name)
+    renderWithTheme(<DocPrimaryResponse response={response} />);
+    const resp = screen.getByText(response.type.name);
 
-    fireEvent.mouseOver(resp)
+    fireEvent.mouseOver(resp);
     await waitFor(() => {
       expect(screen.getByRole('tooltip')).toHaveTextContent(
         `${response.description} ${response.mediaType}`
-      )
-    })
-  })
-})
+      );
+    });
+  });
+});

package/src/components/DocPseudo/DocPrimaryResponse.tsx

@@ -23,13 +23,13 @@
  SOFTWARE.
 
  */
-import type { IMethodResponse } from '@looker/sdk-codegen'
-import type { FC } from 'react'
-import React from 'react'
-import { Tooltip } from '@looker/components'
+import type { IMethodResponse } from '@looker/sdk-codegen';
+import type { FC } from 'react';
+import React from 'react';
+import { Tooltip } from '@looker/components';
 
 export interface DocPrimaryResponseProps {
-  response: IMethodResponse
+  response: IMethodResponse;
 }
 
 export const DocPrimaryResponse: FC<DocPrimaryResponseProps> = ({
@@ -38,4 +38,4 @@ export const DocPrimaryResponse: FC<DocPrimaryResponseProps> = ({
   <Tooltip content={`${response.description} ${response.mediaType}`}>
     <span>{response.type.name}</span>
   </Tooltip>
-)
+);

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

@@ -23,26 +23,28 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { renderWithTheme } from '@looker/components-test-utils'
-import { screen } from '@testing-library/react'
+import React from 'react';
+import { renderWithTheme } from '@looker/components-test-utils';
+import { screen } from '@testing-library/react';
 
-import { api } from '../../test-data'
-import { DocPseudo } from './DocPseudo'
+import { api } from '../../test-data';
+import { DocPseudo } from './DocPseudo';
 
 describe('DocPseudo', () => {
-  const method = api.methods.create_dashboard_filter
+  const method = api.methods.create_dashboard_filter;
 
   test('it renders', () => {
-    renderWithTheme(<DocPseudo method={method} />)
-    expect(screen.getByText(method.name, { exact: false })).toBeInTheDocument()
+    renderWithTheme(<DocPseudo method={method} />);
+    expect(screen.getByText(method.name, { exact: false })).toBeInTheDocument();
 
     method.params.forEach((param) => {
-      expect(screen.getByText(param.name, { exact: false })).toBeInTheDocument()
-    })
+      expect(
+        screen.getByText(param.name, { exact: false })
+      ).toBeInTheDocument();
+    });
 
     expect(
       screen.getByText(method.primaryResponse.type.name)
-    ).toBeInTheDocument()
-  })
-})
+    ).toBeInTheDocument();
+  });
+});

package/src/components/DocPseudo/DocPseudo.tsx

@@ -24,21 +24,21 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import { Code, Flex } from '@looker/components'
-import type { IMethod } from '@looker/sdk-codegen'
+import type { FC } from 'react';
+import React from 'react';
+import { Code, Flex } from '@looker/components';
+import type { IMethod } from '@looker/sdk-codegen';
 
-import { DocPrimaryResponse } from './DocPrimaryResponse'
-import { DocParams } from './DocParams'
+import { DocPrimaryResponse } from './DocPrimaryResponse';
+import { DocParams } from './DocParams';
 
 export interface PseudoProps {
-  method: IMethod
+  method: IMethod;
 }
 
 export const DocPseudo: FC<PseudoProps> = ({ method }) => {
-  const args = method.allParams
-  const resType = method.primaryResponse
+  const args = method.allParams;
+  const resType = method.primaryResponse;
 
   return (
     <Flex alignItems="flex-start">
@@ -49,5 +49,5 @@ export const DocPseudo: FC<PseudoProps> = ({ method }) => {
         <DocPrimaryResponse response={resType} />
       </Code>
     </Flex>
-  )
-}
+  );
+};

package/src/components/DocPseudo/index.tsx

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

package/src/components/DocRateLimited/DocRateLimited.spec.tsx

@@ -23,28 +23,28 @@
  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 { DocRateLimited } from './DocRateLimited'
+import { api } from '../../test-data';
+import { DocRateLimited } from './DocRateLimited';
 
 describe('DocRateLimited', () => {
-  const rateLimitedMethod = api.methods.test_connection
+  const rateLimitedMethod = api.methods.test_connection;
   test('it renders', () => {
-    renderWithTheme(<DocRateLimited method={rateLimitedMethod} />)
-    expect(screen.getByText('rate_limited')).toBeInTheDocument()
-  })
+    renderWithTheme(<DocRateLimited method={rateLimitedMethod} />);
+    expect(screen.getByText('rate_limited')).toBeInTheDocument();
+  });
 
   test('it displays a tooltip with the right information on hover', async () => {
-    renderWithTheme(<DocRateLimited method={rateLimitedMethod} />)
-    const badge = screen.getByText('rate_limited')
-    fireEvent.mouseOver(badge)
+    renderWithTheme(<DocRateLimited method={rateLimitedMethod} />);
+    const badge = screen.getByText('rate_limited');
+    fireEvent.mouseOver(badge);
     await waitFor(() => {
       expect(screen.getByRole('tooltip')).toHaveTextContent(
         'This endpoint is rate limited.'
-      )
-    })
-  })
-})
+      );
+    });
+  });
+});

package/src/components/DocRateLimited/DocRateLimited.tsx

@@ -23,13 +23,13 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import { Code, Tooltip } from '@looker/components'
-import type { IMethod } from '@looker/sdk-codegen'
+import type { FC } from 'react';
+import React from 'react';
+import { Code, Tooltip } from '@looker/components';
+import type { IMethod } from '@looker/sdk-codegen';
 
 interface DocRateLimitedProps {
-  method: IMethod
+  method: IMethod;
 }
 export const DocRateLimited: FC<DocRateLimitedProps> = ({ method }) => (
   <>
@@ -41,4 +41,4 @@ export const DocRateLimited: FC<DocRateLimitedProps> = ({ method }) => (
       </>
     )}
   </>
-)
+);

package/src/components/DocRateLimited/index.ts

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

package/src/components/DocReferences/DocReferences.spec.tsx

@@ -23,23 +23,26 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { methodRefs, typeRefs } from '@looker/sdk-codegen'
-import { screen } from '@testing-library/react'
+import React from 'react';
+import { methodRefs, typeRefs } from '@looker/sdk-codegen';
+import { screen } from '@testing-library/react';
 
 import {
   createTestStore,
   renderWithRouterAndReduxProvider,
-} from '../../test-utils'
-import { api } from '../../test-data'
-import { buildPath } from '../../utils'
-import { DocReferences } from './DocReferences'
+} from '../../test-utils';
+import { api } from '../../test-data';
+import { buildPath } from '../../utils';
+import { DocReferences } from './DocReferences';
 
 describe('DocReferences', () => {
   test('it renders method and type references', () => {
-    const typesUsed = typeRefs(api, api.types.DashboardElement.customTypes)
-    const typesUsedBy = typeRefs(api, api.types.DashboardElement.parentTypes)
-    const methodsUsedBy = methodRefs(api, api.types.DashboardElement.methodRefs)
+    const typesUsed = typeRefs(api, api.types.DashboardElement.customTypes);
+    const typesUsedBy = typeRefs(api, api.types.DashboardElement.parentTypes);
+    const methodsUsedBy = methodRefs(
+      api,
+      api.types.DashboardElement.methodRefs
+    );
     renderWithRouterAndReduxProvider(
       <DocReferences
         typesUsed={typesUsed}
@@ -48,31 +51,31 @@ describe('DocReferences', () => {
         specKey={'4.0'}
         api={api}
       />
-    )
+    );
     expect(screen.getAllByRole('link')).toHaveLength(
       typesUsed.length + typesUsedBy.length + methodsUsedBy.length
-    )
+    );
     expect(screen.getByText(typesUsed[0].name).closest('a')).toHaveAttribute(
       'href',
       buildPath(api, typesUsed[0], '4.0')
-    )
+    );
 
-    expect(typesUsedBy).toHaveLength(1)
-    expect(typesUsedBy[0].name).toEqual('Dashboard')
+    expect(typesUsedBy).toHaveLength(1);
+    expect(typesUsedBy[0].name).toEqual('Dashboard');
     expect(screen.getByText(typesUsedBy[0].name).closest('a')).toHaveAttribute(
       'href',
       buildPath(api, typesUsedBy[0], '4.0')
-    )
+    );
     expect(
       screen.getByText(methodsUsedBy[0].name).closest('a')
-    ).toHaveAttribute('href', buildPath(api, methodsUsedBy[0], '4.0'))
-  })
+    ).toHaveAttribute('href', buildPath(api, methodsUsedBy[0], '4.0'));
+  });
 
   test('it highlights text matching search pattern', () => {
-    const highlightPattern = 'dash'
+    const highlightPattern = 'dash';
     const store = createTestStore({
       settings: { searchPattern: highlightPattern },
-    })
+    });
     renderWithRouterAndReduxProvider(
       <DocReferences
         typesUsed={[api.types.Dashboard]}
@@ -81,12 +84,12 @@ describe('DocReferences', () => {
       />,
       undefined,
       store
-    )
-    const foundRef = screen.getByRole('link')
-    expect(foundRef).toContainHTML('<span class="hi">Dash</span>board')
+    );
+    const foundRef = screen.getByRole('link');
+    expect(foundRef).toContainHTML('<span class="hi">Dash</span>board');
     expect(foundRef).toHaveAttribute(
       'href',
       buildPath(api, api.types.Dashboard, '4.0')
-    )
-  })
-})
+    );
+  });
+});

package/src/components/DocReferences/DocReferences.tsx

@@ -24,21 +24,21 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen'
-import { CollapserCard } from '@looker/run-it'
+import type { FC } from 'react';
+import React from 'react';
+import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen';
+import { CollapserCard } from '@looker/run-it';
 
-import { useSelector } from 'react-redux'
-import { selectSearchPattern } from '../../state'
-import { DocReferenceItems } from './utils'
+import { useSelector } from 'react-redux';
+import { selectSearchPattern } from '../../state';
+import { DocReferenceItems } from './utils';
 
 interface DocReferencesProps {
-  typesUsed: IType[]
-  methodsUsedBy?: IMethod[]
-  typesUsedBy?: IType[]
-  specKey: string
-  api: ApiModel
+  typesUsed: IType[];
+  methodsUsedBy?: IMethod[];
+  typesUsedBy?: IType[];
+  specKey: string;
+  api: ApiModel;
 }
 
 /**
@@ -51,14 +51,14 @@ export const DocReferences: FC<DocReferencesProps> = ({
   methodsUsedBy = [],
   typesUsedBy = [],
 }) => {
-  const searchPattern = useSelector(selectSearchPattern)
+  const searchPattern = useSelector(selectSearchPattern);
 
   if (
     typesUsed.length === 0 &&
     methodsUsedBy.length === 0 &&
     typesUsedBy.length === 0
   )
-    return <></>
+    return <></>;
 
   return (
     <CollapserCard heading="References" id="references">
@@ -86,5 +86,5 @@ export const DocReferences: FC<DocReferencesProps> = ({
         )}
       </>
     </CollapserCard>
-  )
-}
+  );
+};

package/src/components/DocReferences/index.ts

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

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

@@ -25,5 +25,5 @@
  */
 
 describe('DocReferences utils', () => {
-  test.todo('<DocReferenceItems />')
-})
+  test.todo('<DocReferenceItems />');
+});

package/src/components/DocReferences/utils.tsx

@@ -23,11 +23,11 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen'
-import { Link } from 'react-router-dom'
-import { RunItHeading } from '@looker/run-it'
-import { buildPath, highlightHTML } from '../../utils'
+import React from 'react';
+import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen';
+import { Link } from 'react-router-dom';
+import { RunItHeading } from '@looker/run-it';
+import { buildPath, highlightHTML } from '../../utils';
 
 /**
  * Renders a heading and links to all item types
@@ -39,7 +39,7 @@ export const DocReferenceItems = (
   specKey: string,
   pattern: string
 ) => {
-  if (items.length === 0) return <></>
+  if (items.length === 0) return <></>;
 
   return (
     <>
@@ -53,5 +53,5 @@ export const DocReferenceItems = (
         </span>
       ))}
     </>
-  )
-}
+  );
+};

package/src/components/DocSDKs/DocDeclarations.tsx

@@ -23,14 +23,14 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { Tab2, Tabs2 } from '@looker/components'
-import type { KeyedCollection } from '@looker/sdk-codegen'
-import type { FC } from 'react'
-import { DocCode } from '../DocCode'
+import React from 'react';
+import { Tab2, Tabs2 } from '@looker/components';
+import type { KeyedCollection } from '@looker/sdk-codegen';
+import type { FC } from 'react';
+import { DocCode } from '../DocCode';
 
 interface DocDeclarationsProps {
-  declarations: KeyedCollection<string>
+  declarations: KeyedCollection<string>;
 }
 
 /**
@@ -45,4 +45,4 @@ export const DocDeclarations: FC<DocDeclarationsProps> = ({ declarations }) => (
       </Tab2>
     ))}
   </Tabs2>
-)
+);