@looker/api-explorer 0.9.54 → 0.9.57

package/src/components/ErrorBoundary/components/SomethingWentWrong/components/index.ts

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

package/src/components/ErrorBoundary/components/SomethingWentWrong/index.ts

@@ -23,5 +23,5 @@
  SOFTWARE.
 
  */
-export { SomethingWentWrong } from './SomethingWentWrong'
-export type { SomethingWentWrongProps } from './SomethingWentWrong'
+export { SomethingWentWrong } from './SomethingWentWrong';
+export type { SomethingWentWrongProps } from './SomethingWentWrong';

package/src/components/ErrorBoundary/index.ts

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

package/src/components/ExploreType/ExploreProperty.spec.tsx

@@ -24,89 +24,91 @@
 
  */
 
-import React from 'react'
-import { fireEvent, screen, waitFor } from '@testing-library/react'
-import { IdeFileManifest } from '@looker/icons'
-import { Toc } from '@styled-icons/material/Toc'
-import { Tag } from '@styled-icons/material-rounded/Tag'
+import React from 'react';
+import { fireEvent, screen, waitFor } from '@testing-library/react';
+import { IdeFileManifest } from '@looker/icons';
+import { Toc } from '@styled-icons/material/Toc';
+import { Tag } from '@styled-icons/material-rounded/Tag';
 
-import { api } from '../../test-data'
-import { renderWithRouter } from '../../test-utils'
-import { ExploreProperty, ExplorePropertyDetail, typeIcon } from '.'
+import { api } from '../../test-data';
+import { renderWithRouter } from '../../test-utils';
+import { ExploreProperty, ExplorePropertyDetail, typeIcon } from '.';
 
 describe('ExploreProperty', () => {
-  const type = api.types.CreateDashboardFilter
+  const type = api.types.CreateDashboardFilter;
 
   describe('ExplorePropertyDetail', () => {
     describe('CreateDashboardFilter', () => {
       test('Shows read-only property and description', async () => {
-        const property = type.properties.id
-        expect(property).toBeDefined()
+        const property = type.properties.id;
+        expect(property).toBeDefined();
         renderWithRouter(
           <ExplorePropertyDetail api={api} property={property} />
-        )
-        expect(property.deprecated).toEqual(false)
-        expect(property.readOnly).toEqual(true)
+        );
+        expect(property.deprecated).toEqual(false);
+        expect(property.readOnly).toEqual(true);
         // eslint-disable-next-line jest-dom/prefer-required
-        expect(property.required).toEqual(false)
-        expect(screen.getByText(property.description)).toBeInTheDocument()
+        expect(property.required).toEqual(false);
+        expect(screen.getByText(property.description)).toBeInTheDocument();
         await waitFor(() => {
-          const statusIcon = screen.getByTitle('read-only property')
-          fireEvent.mouseOver(statusIcon)
+          const statusIcon = screen.getByTitle('read-only property');
+          // eslint-disable-next-line testing-library/no-wait-for-side-effects
+          fireEvent.mouseOver(statusIcon);
           expect(screen.getByRole('tooltip')).toHaveTextContent(
             'CreateDashboardFilter.id is read-only'
-          )
-        })
-      })
+          );
+        });
+      });
 
       test('Shows required property and description', async () => {
-        const property = type.properties.dashboard_id
-        expect(property).toBeDefined()
+        const property = type.properties.dashboard_id;
+        expect(property).toBeDefined();
         renderWithRouter(
           <ExplorePropertyDetail api={api} property={property} />
-        )
-        expect(property.deprecated).toEqual(false)
-        expect(property.readOnly).toEqual(false)
+        );
+        expect(property.deprecated).toEqual(false);
+        expect(property.readOnly).toEqual(false);
         // eslint-disable-next-line jest-dom/prefer-required
-        expect(property.required).toEqual(true)
-        expect(screen.getByText(property.description)).toBeInTheDocument()
+        expect(property.required).toEqual(true);
+        expect(screen.getByText(property.description)).toBeInTheDocument();
         await waitFor(() => {
-          const statusIcon = screen.getByTitle('required property')
-          fireEvent.mouseOver(statusIcon)
+          const statusIcon = screen.getByTitle('required property');
+          // eslint-disable-next-line testing-library/no-wait-for-side-effects
+          fireEvent.mouseOver(statusIcon);
           expect(screen.getByRole('tooltip')).toHaveTextContent(
             'CreateDashboardFilter.dashboard_id is required'
-          )
-        })
-      })
-    })
-  })
+          );
+        });
+      });
+    });
+  });
 
   describe('property icons', () => {
     test('int64 property icon is correct', () => {
-      const property = type.properties.row
-      expect(property.type.jsonName).toEqual('int64')
-      renderWithRouter(<ExploreProperty api={api} property={property} />)
-      expect(screen.getByTitle('int64')).toBeInTheDocument()
-      const legend = typeIcon(property.type)
-      expect(legend).toEqual({ icon: <Tag />, title: 'int64' })
-    })
+      const property = type.properties.row;
+      expect(property.type.jsonName).toEqual('int64');
+      renderWithRouter(<ExploreProperty api={api} property={property} />);
+      expect(screen.getByTitle('int64')).toBeInTheDocument();
+      const legend = typeIcon(property.type);
+      expect(legend).toEqual({ icon: <Tag />, title: 'int64' });
+    });
 
     test('array property icon is correct', () => {
-      const property = type.properties.listens_to_filters
-      expect(property.type.jsonName).toEqual('string[]')
-      renderWithRouter(<ExploreProperty api={api} property={property} />)
-      expect(screen.getByTitle(property.type.jsonName)).toBeInTheDocument()
-      const legend = typeIcon(property.type)
-      expect(legend).toEqual({ icon: <Toc />, title: 'string[]' })
-    })
+      const property = type.properties.listens_to_filters;
+      expect(property.type.jsonName).toEqual('string[]');
+      renderWithRouter(<ExploreProperty api={api} property={property} />);
+      expect(screen.getByTitle(property.type.jsonName)).toBeInTheDocument();
+      const legend = typeIcon(property.type);
+      expect(legend).toEqual({ icon: <Toc />, title: 'string[]' });
+    });
 
     test('hash property icon is correct', () => {
-      const property = type.properties.field
-      expect(property.type.jsonName).toEqual('Hash[any]')
-      renderWithRouter(<ExploreProperty api={api} property={property} />)
-      expect(screen.getByTitle(property.type.jsonName)).toBeInTheDocument()
-      const legend = typeIcon(property.type)
-      expect(legend).toEqual({ icon: <IdeFileManifest />, title: 'Hash[any]' })
-    })
-  })
-})
+      const property = type.properties.field;
+      expect(property.type.jsonName).toEqual('Hash[any]');
+      renderWithRouter(<ExploreProperty api={api} property={property} />);
+      expect(screen.getByTitle(property.type.jsonName)).toBeInTheDocument();
+      const legend = typeIcon(property.type);
+      expect(legend).toEqual({ icon: <IdeFileManifest />, title: 'Hash[any]' });
+    });
+  });
+});

package/src/components/ExploreType/ExploreProperty.tsx

@@ -24,36 +24,36 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import type { IconType } from '@looker/components'
+import type { FC } from 'react';
+import React from 'react';
+import type { IconType } from '@looker/components';
 import {
   Box,
   Icon,
+  Paragraph,
+  Space,
+  Tooltip,
   Tree,
   TreeItem,
-  Tooltip,
-  Space,
-  Paragraph,
-} from '@looker/components'
-import { Done } from '@styled-icons/material/Done'
-import { Lock } from '@styled-icons/material/Lock'
-import { Remove } from '@styled-icons/material/Remove'
-import type { IProperty, ApiModel } from '@looker/sdk-codegen'
-import { Markdown } from '@looker/code-editor'
+} from '@looker/components';
+import { Done } from '@styled-icons/material/Done';
+import { Lock } from '@styled-icons/material/Lock';
+import { Remove } from '@styled-icons/material/Remove';
+import type { ApiModel, IProperty } from '@looker/sdk-codegen';
+import { Markdown } from '@looker/code-editor';
 import {
-  expandable,
   ExploreTypeLink,
+  expandable,
   pickType,
   pickTypeProps,
   typeIcon,
-} from '.'
+} from '.';
 
 interface TipIconProps {
-  show: boolean
-  tip: string
-  icon: IconType
-  title: string
+  show: boolean;
+  tip: string;
+  icon: IconType;
+  title: string;
 }
 
 /**
@@ -65,26 +65,26 @@ interface TipIconProps {
  * @constructor
  */
 export const TipIcon: FC<TipIconProps> = ({ show, tip, icon, title }) => {
-  if (!show) return <></>
+  if (!show) return <></>;
   return (
     <Tooltip content={tip}>
       <Icon icon={icon} size="xsmall" content={tip} title={title} />
     </Tooltip>
-  )
-}
+  );
+};
 
 /**
  * Interface shared by several ExploreProperty components
  */
 interface ExplorePropertyProps {
   /** property to explore */
-  property: IProperty
+  property: IProperty;
   /** the current level of the hierarchy */
-  level?: number
+  level?: number;
   /** the maximum depth to expanded nested types. -1 = all (default), 0 = no expansion */
-  maxDepth?: number
+  maxDepth?: number;
   /** open all nodes immediately? */
-  openAll?: boolean
+  openAll?: boolean;
 }
 
 /**
@@ -95,7 +95,7 @@ interface ExplorePropertyProps {
 export const ExplorePropertyRequired: FC<ExplorePropertyProps> = ({
   property,
 }) => {
-  const tip = `${property.fullName} is required`
+  const tip = `${property.fullName} is required`;
   return (
     <TipIcon
       show={property.required}
@@ -103,8 +103,8 @@ export const ExplorePropertyRequired: FC<ExplorePropertyProps> = ({
       tip={tip}
       title="required property"
     />
-  )
-}
+  );
+};
 
 /**
  * Show deprecated status if a property is deprecated
@@ -114,7 +114,7 @@ export const ExplorePropertyRequired: FC<ExplorePropertyProps> = ({
 export const ExplorePropertyDeprecated: FC<ExplorePropertyProps> = ({
   property,
 }) => {
-  const tip = `${property.fullName} is deprecated`
+  const tip = `${property.fullName} is deprecated`;
   return (
     <TipIcon
       show={property.deprecated}
@@ -122,8 +122,8 @@ export const ExplorePropertyDeprecated: FC<ExplorePropertyProps> = ({
       tip={tip}
       title="deprecated property"
     />
-  )
-}
+  );
+};
 
 /**
  * Show read-only status if a property is read-only
@@ -133,7 +133,7 @@ export const ExplorePropertyDeprecated: FC<ExplorePropertyProps> = ({
 export const ExplorePropertyReadOnly: FC<ExplorePropertyProps> = ({
   property,
 }) => {
-  const tip = `${property.fullName} is read-only`
+  const tip = `${property.fullName} is read-only`;
   return (
     <TipIcon
       show={property.readOnly}
@@ -141,8 +141,8 @@ export const ExplorePropertyReadOnly: FC<ExplorePropertyProps> = ({
       tip={tip}
       title="read-only property"
     />
-  )
-}
+  );
+};
 
 /**
  * Display the property description if it's assigned
@@ -151,7 +151,7 @@ export const ExplorePropertyReadOnly: FC<ExplorePropertyProps> = ({
  */
 const DescriptionParagraph: FC = (props) => (
   <Paragraph fontSize="small" m="none" {...props} />
-)
+);
 
 const ExplorePropertyDescription: FC<ExplorePropertyProps> = ({ property }) =>
   property.description ? (
@@ -159,11 +159,11 @@ const ExplorePropertyDescription: FC<ExplorePropertyProps> = ({ property }) =>
       source={property.description}
       paragraphOverride={DescriptionParagraph}
     />
-  ) : null
+  ) : null;
 
 interface ExploreApiPropertyProps extends ExplorePropertyProps {
   /** parsed api */
-  api: ApiModel
+  api: ApiModel;
 }
 
 /**
@@ -188,7 +188,7 @@ export const ExplorePropertyDetail: FC<ExploreApiPropertyProps> = ({
       <ExplorePropertyDescription property={property} />
     </Box>
   </Space>
-)
+);
 
 /**
  * Render a potentially complex property as a non-expanding node
@@ -199,7 +199,7 @@ export const ExplorePropertyNode: FC<ExploreApiPropertyProps> = ({
   property,
   api,
 }) => {
-  const legend = typeIcon(property.type)
+  const legend = typeIcon(property.type);
   return (
     <TreeItem
       {...legend}
@@ -207,8 +207,8 @@ export const ExplorePropertyNode: FC<ExploreApiPropertyProps> = ({
     >
       {property.jsonName}
     </TreeItem>
-  )
-}
+  );
+};
 
 /**
  * Render the Tree or TreeItem for this property
@@ -225,7 +225,7 @@ export const ExploreProperty: FC<ExploreApiPropertyProps> = ({
   maxDepth = -1,
   openAll = false,
 }) => {
-  const picked = pickType(property.type)
+  const picked = pickType(property.type);
   if (!picked.intrinsic) {
     return (
       <ExplorePropertyType
@@ -236,14 +236,14 @@ export const ExploreProperty: FC<ExploreApiPropertyProps> = ({
         maxDepth={maxDepth}
         openAll={openAll}
       />
-    )
+    );
   }
-  return <ExplorePropertyNode api={api} property={property} />
-}
+  return <ExplorePropertyNode api={api} property={property} />;
+};
 
 interface ExplorePropertyTypeProps extends ExploreApiPropertyProps {
   /** Open the node display immediately? */
-  open?: boolean
+  open?: boolean;
 }
 
 export const ExplorePropertyType: FC<ExplorePropertyTypeProps> = ({
@@ -254,12 +254,12 @@ export const ExplorePropertyType: FC<ExplorePropertyTypeProps> = ({
   maxDepth = -1,
   openAll = false,
 }) => {
-  const type = property.type
-  const props = pickTypeProps(type)
-  const nest = expandable(level, maxDepth)
-  const legend = typeIcon(type)
+  const type = property.type;
+  const props = pickTypeProps(type);
+  const nest = expandable(level, maxDepth);
+  const legend = typeIcon(type);
   if (!nest) {
-    return <ExplorePropertyNode api={api} property={property} />
+    return <ExplorePropertyNode api={api} property={property} />;
   }
   return (
     <Tree
@@ -281,5 +281,5 @@ export const ExplorePropertyType: FC<ExplorePropertyTypeProps> = ({
         />
       ))}
     </Tree>
-  )
-}
+  );
+};

package/src/components/ExploreType/ExploreType.spec.tsx

@@ -24,69 +24,71 @@
 
  */
 
-import React from 'react'
-import { screen } from '@testing-library/react'
+import React from 'react';
+import { screen } from '@testing-library/react';
 
-import { api } from '../../test-data'
-import { renderWithRouter } from '../../test-utils'
-import { ExploreType, ExploreTypeLink } from '.'
+import { api } from '../../test-data';
+import { renderWithRouter } from '../../test-utils';
+import { ExploreType, ExploreTypeLink } from '.';
 
 describe('ExploreType', () => {
-  const targetType = api.types.ColorCollection
-  const colors = 'colors'
-  const colorsExpected = 1
-  const stops = 'stops'
-  const stopsExpected = 2
-  const offset = 'offset'
-  const offsetExpected = 2
+  const targetType = api.types.ColorCollection;
+  const colors = 'colors';
+  const colorsExpected = 1;
+  const stops = 'stops';
+  const stopsExpected = 2;
+  const offset = 'offset';
+  const offsetExpected = 2;
 
   test('expands all when openAll is true and expand defaults', () => {
-    renderWithRouter(<ExploreType api={api} type={targetType} openAll={true} />)
+    renderWithRouter(
+      <ExploreType api={api} type={targetType} openAll={true} />
+    );
 
-    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument()
-    expect(screen.queryAllByText(colors)).toHaveLength(colorsExpected)
-    expect(screen.queryAllByText(stops)).toHaveLength(stopsExpected)
-    expect(screen.queryAllByText(offset)).toHaveLength(offsetExpected)
-  })
+    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument();
+    expect(screen.queryAllByText(colors)).toHaveLength(colorsExpected);
+    expect(screen.queryAllByText(stops)).toHaveLength(stopsExpected);
+    expect(screen.queryAllByText(offset)).toHaveLength(offsetExpected);
+  });
 
   test('expands nothing if maxDepth is 0', () => {
     renderWithRouter(
       <ExploreType api={api} type={targetType} openAll={true} maxDepth={0} />
-    )
+    );
 
-    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument()
+    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument();
     // eslint-disable-next-line jest-dom/prefer-in-document
-    expect(screen.queryAllByText(colors)).toHaveLength(0)
+    expect(screen.queryAllByText(colors)).toHaveLength(0);
     // eslint-disable-next-line jest-dom/prefer-in-document
-    expect(screen.queryAllByText(stops)).toHaveLength(0)
+    expect(screen.queryAllByText(stops)).toHaveLength(0);
     // eslint-disable-next-line jest-dom/prefer-in-document
-    expect(screen.queryAllByText(offset)).toHaveLength(0)
-  })
+    expect(screen.queryAllByText(offset)).toHaveLength(0);
+  });
 
   test('expands 2 levels only', () => {
     renderWithRouter(
       <ExploreType api={api} type={targetType} maxDepth={2} openAll={true} />
-    )
+    );
 
-    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument()
-    expect(screen.queryAllByText(colors)).toHaveLength(colorsExpected)
-    expect(screen.queryAllByText(stops)).toHaveLength(stopsExpected)
+    expect(screen.getByText(targetType.jsonName)).toBeInTheDocument();
+    expect(screen.queryAllByText(colors)).toHaveLength(colorsExpected);
+    expect(screen.queryAllByText(stops)).toHaveLength(stopsExpected);
     // eslint-disable-next-line jest-dom/prefer-in-document
-    expect(screen.queryAllByText(offset)).toHaveLength(0)
-  })
+    expect(screen.queryAllByText(offset)).toHaveLength(0);
+  });
 
   describe('ExploreTypeLink', () => {
     test('recognizes 4.0', () => {
-      const specKey = '4.0'
-      const path = `/${specKey}/methods/foo`
-      renderWithRouter(<ExploreTypeLink api={api} type={targetType} />, [path])
+      const specKey = '4.0';
+      const path = `/${specKey}/methods/foo`;
+      renderWithRouter(<ExploreTypeLink api={api} type={targetType} />, [path]);
 
-      const actual = screen.getByText(targetType.jsonName)
-      expect(actual).toBeInTheDocument()
+      const actual = screen.getByText(targetType.jsonName);
+      expect(actual).toBeInTheDocument();
       expect(actual).toHaveProperty(
         'href',
         `http://localhost/${specKey}/types/ColorCollection/${targetType.jsonName}`
-      )
-    })
-  })
-})
+      );
+    });
+  });
+});

package/src/components/ExploreType/ExploreType.tsx

@@ -24,15 +24,15 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
-import { Code, Tree, TreeItem } from '@looker/components'
-import type { IType, ApiModel } from '@looker/sdk-codegen'
-import { TypeOfType, typeOfType } from '@looker/sdk-codegen'
-import { useRouteMatch } from 'react-router-dom'
+import type { FC } from 'react';
+import React from 'react';
+import { Code, Tree, TreeItem } from '@looker/components';
+import type { ApiModel, IType } from '@looker/sdk-codegen';
+import { TypeOfType, typeOfType } from '@looker/sdk-codegen';
+import { useRouteMatch } from 'react-router-dom';
 
-import { Link } from '../Link'
-import { buildPath } from '../../utils'
+import { Link } from '../Link';
+import { buildPath } from '../../utils';
 import {
   ExploreProperty,
   pickType,
@@ -40,23 +40,23 @@ import {
   typeIcon,
   typeLinkPrefix,
   typeLinkSuffix,
-} from '.'
+} from '.';
 
 interface ExploreTypeLinkProps {
-  type: IType
-  api: ApiModel
+  type: IType;
+  api: ApiModel;
 }
 
 export const ExploreTypeLink: FC<ExploreTypeLinkProps> = ({ type, api }) => {
-  const match = useRouteMatch<{ specKey: string }>('/:specKey')
-  const specKey = match?.params.specKey
-  const picked = pickType(type)
-  const name = picked.name
-  const prefix = typeLinkPrefix(type)
-  const suffix = typeLinkSuffix(type)
-  const typed = typeOfType(picked)
+  const match = useRouteMatch<{ specKey: string }>('/:specKey');
+  const specKey = match?.params.specKey;
+  const picked = pickType(type);
+  const name = picked.name;
+  const prefix = typeLinkPrefix(type);
+  const suffix = typeLinkSuffix(type);
+  const typed = typeOfType(picked);
   if (typed === TypeOfType.Intrinsic)
-    return <Code fontSize="small">{type.jsonName}</Code>
+    return <Code fontSize="small">{type.jsonName}</Code>;
   return (
     <>
       {prefix}
@@ -65,24 +65,24 @@ export const ExploreTypeLink: FC<ExploreTypeLinkProps> = ({ type, api }) => {
       </Link>
       {suffix}
     </>
-  )
-}
+  );
+};
 
 interface ExploreTypeProps {
   /** Type to explore */
-  type: IType
+  type: IType;
   /** parsed specification */
-  api: ApiModel
+  api: ApiModel;
   /** Open the node display immediately */
-  open?: boolean
+  open?: boolean;
   /** Create a link to the type? */
-  link?: boolean
+  link?: boolean;
   /** the nesting level of the type */
-  level?: number
+  level?: number;
   /** the maximum depth to expanded nested types. -1 = all (default), 0 = no expansion */
-  maxDepth?: number
+  maxDepth?: number;
   /** open all nodes immediately? */
-  openAll?: boolean
+  openAll?: boolean;
 }
 
 export const ExploreType: FC<ExploreTypeProps> = ({
@@ -94,9 +94,9 @@ export const ExploreType: FC<ExploreTypeProps> = ({
   maxDepth = -1,
   openAll = false,
 }) => {
-  const props = pickTypeProps(type)
-  const nest = maxDepth === -1 || level < maxDepth
-  const legend = typeIcon(type)
+  const props = pickTypeProps(type);
+  const nest = maxDepth === -1 || level < maxDepth;
+  const legend = typeIcon(type);
   return (
     <Tree
       border
@@ -125,5 +125,5 @@ export const ExploreType: FC<ExploreTypeProps> = ({
           />
         ))}
     </Tree>
-  )
-}
+  );
+};