@looker/api-explorer 0.9.55 → 0.9.57

package/src/components/DocSDKs/DocSDKs.spec.tsx

@@ -23,20 +23,20 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { screen } from '@testing-library/react'
-import { codeGenerators } from '@looker/sdk-codegen'
-import type { Store } from 'redux'
+import React from 'react';
+import { screen } from '@testing-library/react';
+import { codeGenerators } from '@looker/sdk-codegen';
+import type { Store } from 'redux';
 
-import { api } from '../../test-data'
-import { renderWithReduxProvider, createTestStore } from '../../test-utils'
-import type { RootState } from '../../state'
-import { DocSDKs } from './DocSDKs'
+import { api } from '../../test-data';
+import { createTestStore, renderWithReduxProvider } from '../../test-utils';
+import type { RootState } from '../../state';
+import { DocSDKs } from './DocSDKs';
 
 describe('DocSDKs', () => {
-  let store: Store<RootState>
-  const supportedLanguages = codeGenerators.map((g) => g.language)
-  const pattern = new RegExp(`${supportedLanguages.join('|')}`)
+  let store: Store<RootState>;
+  const supportedLanguages = codeGenerators.map((g) => g.language);
+  const pattern = new RegExp(`${supportedLanguages.join('|')}`);
 
   beforeAll(() => {
     store = createTestStore({
@@ -44,8 +44,8 @@ describe('DocSDKs', () => {
         initialized: false,
         sdkLanguage: 'All',
       },
-    })
-  })
+    });
+  });
 
   test.each([
     ['method', { method: api.methods.run_look }],
@@ -53,14 +53,14 @@ describe('DocSDKs', () => {
   ])(
     'it can render an SDK declaration for all supported languages',
     (_, props) => {
-      renderWithReduxProvider(<DocSDKs api={api} {...props} />, store)
+      renderWithReduxProvider(<DocSDKs api={api} {...props} />, store);
       expect(
         screen.getAllByRole('tab', {
           name: pattern,
         })
-      ).toHaveLength(supportedLanguages.length)
+      ).toHaveLength(supportedLanguages.length);
     }
-  )
+  );
 
   test.each(supportedLanguages)(
     'it can render a %s method declaration',
@@ -70,15 +70,15 @@ describe('DocSDKs', () => {
           initialized: false,
           sdkLanguage: sdkLanguage,
         },
-      })
+      });
       renderWithReduxProvider(
         <DocSDKs api={api} method={api.methods.run_look} />,
         store
-      )
-      expect(screen.queryByRole('tab')).not.toBeInTheDocument()
+      );
+      expect(screen.queryByRole('tab')).not.toBeInTheDocument();
       expect(
         screen.getByRole('heading', { name: `${sdkLanguage} Declaration` })
-      ).toBeInTheDocument()
+      ).toBeInTheDocument();
     }
-  )
-})
+  );
+});

package/src/components/DocSDKs/DocSDKs.tsx

@@ -24,31 +24,31 @@
 
  */
 
-import type { FC } from 'react'
-import React, { useState, useEffect } from 'react'
-import { useSelector } from 'react-redux'
+import type { FC } from 'react';
+import React, { useEffect, useState } from 'react';
+import { useSelector } from 'react-redux';
 import type {
+  ApiModel,
+  CodeGen,
   IMethod,
   IType,
-  ApiModel,
   KeyedCollection,
-  CodeGen,
-} from '@looker/sdk-codegen'
-import { CollapserCard, getGenerators } from '@looker/run-it'
+} from '@looker/sdk-codegen';
+import { CollapserCard, getGenerators } from '@looker/run-it';
 
-import { DocCode } from '../DocCode'
-import { selectSdkLanguage } from '../../state'
-import { isMethod } from '../../utils/path'
-import { noComment } from './utils'
-import { DocDeclarations } from './DocDeclarations'
+import { DocCode } from '../DocCode';
+import { selectSdkLanguage } from '../../state';
+import { isMethod } from '../../utils/path';
+import { noComment } from './utils';
+import { DocDeclarations } from './DocDeclarations';
 
 interface LanguageSDKProps {
   /** API spec */
-  api: ApiModel
+  api: ApiModel;
   /** An SDK method */
-  method?: IMethod
+  method?: IMethod;
   /** An SDK type */
-  type?: IType
+  type?: IType;
 }
 
 const getDeclarations = (
@@ -56,44 +56,44 @@ const getDeclarations = (
   sdkLanguage: string,
   item: IMethod | IType
 ) => {
-  const declarations: KeyedCollection<string> = {}
+  const declarations: KeyedCollection<string> = {};
   Object.entries(generators).forEach(([language, gen]) => {
     if (sdkLanguage === 'All' || language === sdkLanguage) {
       const code = isMethod(item)
         ? gen.declareMethod('', item as IMethod)
-        : gen.declareType('', item as IType)
-      declarations[language] = code
+        : gen.declareType('', item as IType);
+      declarations[language] = code;
     }
-  })
-  return declarations
-}
+  });
+  return declarations;
+};
 
 /**
  * Given a method or a type, it renders its SDK declaration in all supported languages.
  */
 export const DocSDKs: FC<LanguageSDKProps> = ({ api, method, type }) => {
-  const sdkLanguage = useSelector(selectSdkLanguage)
-  const generators = getGenerators(api)
-  const [item, setItem] = useState(method ? noComment(method) : type!)
+  const sdkLanguage = useSelector(selectSdkLanguage);
+  const generators = getGenerators(api);
+  const [item, setItem] = useState(method ? noComment(method) : type!);
   const [declarations, setDeclarations] = useState(
     getDeclarations(generators, sdkLanguage, item)
-  )
-  const [header, setHeader] = useState(`${sdkLanguage} Declaration`)
+  );
+  const [header, setHeader] = useState(`${sdkLanguage} Declaration`);
 
   useEffect(() => {
-    setItem(method ? noComment(method) : type!)
-  }, [method, type])
+    setItem(method ? noComment(method) : type!);
+  }, [method, type]);
 
   useEffect(() => {
-    const declarations = getDeclarations(generators, sdkLanguage, item)
-    setDeclarations(declarations)
-    const languages = Object.keys(declarations)
+    const declarations = getDeclarations(generators, sdkLanguage, item);
+    setDeclarations(declarations);
+    const languages = Object.keys(declarations);
     if (languages.length > 1) {
-      setHeader('Declarations')
+      setHeader('Declarations');
     } else {
-      setHeader(`${languages[0]} Declaration`)
+      setHeader(`${languages[0]} Declaration`);
     }
-  }, [sdkLanguage, item])
+  }, [sdkLanguage, item]);
 
   return (
     <CollapserCard heading={header} id="sdk declarations">
@@ -106,5 +106,5 @@ export const DocSDKs: FC<LanguageSDKProps> = ({ api, method, type }) => {
         />
       )}
     </CollapserCard>
-  )
-}
+  );
+};

package/src/components/DocSDKs/index.ts

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

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

@@ -23,14 +23,14 @@
  SOFTWARE.
 
  */
-import { api } from '../../test-data'
-import { noComment } from './utils'
+import { api } from '../../test-data';
+import { noComment } from './utils';
 
 describe('DocSDKs utils', () => {
   test('noComment removes method comments', () => {
-    const original = api.methods.query
-    expect(original.description).not.toHaveLength(0)
-    const actual = noComment(original)
-    expect(actual.description).toHaveLength(0)
-  })
-})
+    const original = api.methods.query;
+    expect(original.description).not.toHaveLength(0);
+    const actual = noComment(original);
+    expect(actual.description).toHaveLength(0);
+  });
+});

package/src/components/DocSDKs/utils.ts

@@ -23,15 +23,15 @@
  SOFTWARE.
 
  */
-import type { IMethod } from '@looker/sdk-codegen'
-import clone from 'lodash/clone'
+import type { IMethod } from '@looker/sdk-codegen';
+import clone from 'lodash/clone';
 
 /**
  * Given a method create a copy and remove its description
  * @param method An SDK method
  */
 export const noComment = (method: IMethod): IMethod => {
-  const copy = clone(method)
-  copy.description = ''
-  return copy
-}
+  const copy = clone(method);
+  copy.description = '';
+  return copy;
+};

package/src/components/DocSchema/DocSchema.tsx

@@ -24,22 +24,22 @@
 
  */
 
-import type { FC } from 'react'
-import React from 'react'
+import type { FC } from 'react';
+import React from 'react';
 
-import { CodeDisplay } from '@looker/code-editor'
-import { CollapserCard } from '@looker/run-it'
+import { CodeDisplay } from '@looker/code-editor';
+import { CollapserCard } from '@looker/run-it';
 
 interface DocSchemaProps {
-  object: any
+  object: any;
 }
 
 /**
  * It renders links to the given types and/or methods references
  */
 export const DocSchema: FC<DocSchemaProps> = ({ object }) => {
-  if (!object) return <></>
-  const json = JSON.stringify(object, null, 2)
+  if (!object) return <></>;
+  const json = JSON.stringify(object, null, 2);
 
   return (
     <CollapserCard
@@ -51,5 +51,5 @@ export const DocSchema: FC<DocSchemaProps> = ({ object }) => {
         <CodeDisplay language="json" code={json} />
       </>
     </CollapserCard>
-  )
-}
+  );
+};

package/src/components/DocSchema/index.ts

@@ -24,4 +24,4 @@
 
  */
 
-export { DocSchema } from './DocSchema'
+export { DocSchema } from './DocSchema';

package/src/components/DocSdkUsage/DocSdkExampleCell.tsx

@@ -23,11 +23,11 @@
  SOFTWARE.
 
  */
-import type { FC, PropsWithChildren } from 'react'
-import React from 'react'
-import { DataTableCell, Span } from '@looker/components'
+import type { FC, PropsWithChildren } from 'react';
+import React from 'react';
+import { DataTableCell, Span } from '@looker/components';
 
-import { getTableItemBottomBorder } from './utils'
+import { getTableItemBottomBorder } from './utils';
 
 export const DocSdkExampleCell: FC<PropsWithChildren<any>> = (props) => (
   <DataTableCell
@@ -37,4 +37,4 @@ export const DocSdkExampleCell: FC<PropsWithChildren<any>> = (props) => (
       {props.children}
     </Span>
   </DataTableCell>
-)
+);

package/src/components/DocSdkUsage/DocSdkUsage.spec.tsx

@@ -23,38 +23,38 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { screen } from '@testing-library/react'
-import { findExampleLanguages } from '@looker/sdk-codegen'
+import React from 'react';
+import { screen } from '@testing-library/react';
+import { findExampleLanguages } from '@looker/sdk-codegen';
 
-import { renderWithLode } from '../../test-utils'
-import { api, examples } from '../../test-data'
-import { DocSdkUsage } from './DocSdkUsage'
+import { renderWithLode } from '../../test-utils';
+import { api, examples } from '../../test-data';
+import { DocSdkUsage } from './DocSdkUsage';
 import {
-  prepareExampleDataTable,
   PER_PAGE_COUNT,
-  sortLanguagesByPreference,
   getFileNameFromPath,
-} from './utils'
+  prepareExampleDataTable,
+  sortLanguagesByPreference,
+} from './utils';
 
 describe('DocSdkUsage', () => {
   test('it renders links to sdk examples', () => {
-    const method = api.methods.run_look
-    const languages = findExampleLanguages(examples, method.name)
+    const method = api.methods.run_look;
+    const languages = findExampleLanguages(examples, method.name);
     const { pageExamples } = prepareExampleDataTable(
       languages,
       examples,
       method.operationId,
       1
-    )
-    renderWithLode(<DocSdkUsage method={method} />, examples)
-    expect(screen.getAllByRole('link')).toHaveLength(PER_PAGE_COUNT)
+    );
+    renderWithLode(<DocSdkUsage method={method} />, examples);
+    expect(screen.getAllByRole('link')).toHaveLength(PER_PAGE_COUNT);
 
     expect(
       screen.getAllByText(pageExamples[0].filename)[0].closest('a')
-    ).toHaveAttribute('href', pageExamples[0].permalink)
-  })
-})
+    ).toHaveAttribute('href', pageExamples[0].permalink);
+  });
+});
 
 describe('DocSdkUsage utils', () => {
   test('preferred language examples come first', () => {
@@ -63,12 +63,12 @@ describe('DocSdkUsage utils', () => {
         ['python', 'typescript', 'csharp'],
         'typescript'
       )
-    ).toEqual(['typescript', 'python', 'csharp'])
-  })
+    ).toEqual(['typescript', 'python', 'csharp']);
+  });
 
   test('can get filename from path', () => {
     expect(
       getFileNameFromPath('/sdk-codegen/packages/foo.py line 200')
-    ).toEqual('foo.py')
-  })
-})
+    ).toEqual('foo.py');
+  });
+});

package/src/components/DocSdkUsage/DocSdkUsage.tsx

@@ -23,8 +23,8 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React, { useState, useEffect } from 'react'
+import type { FC } from 'react';
+import React, { useEffect, useState } from 'react';
 import {
   Box,
   Card,
@@ -32,27 +32,27 @@ import {
   DataTableItem,
   Icon,
   Link,
-  Space,
   Pagination,
-} from '@looker/components'
-import type { IMethod } from '@looker/sdk-codegen'
-import { findExampleLanguages } from '@looker/sdk-codegen'
-import { CollapserCard } from '@looker/run-it'
-import { InsertDriveFile } from '@styled-icons/material-outlined/InsertDriveFile'
-import { useSelector } from 'react-redux'
+  Space,
+} from '@looker/components';
+import type { IMethod } from '@looker/sdk-codegen';
+import { findExampleLanguages } from '@looker/sdk-codegen';
+import { CollapserCard } from '@looker/run-it';
+import { InsertDriveFile } from '@styled-icons/material-outlined/InsertDriveFile';
+import { useSelector } from 'react-redux';
 
-import { selectSdkLanguage, selectExamplesLode } from '../../state'
+import { selectExamplesLode, selectSdkLanguage } from '../../state';
 import {
-  exampleColumns,
   EMPTY_STRING,
-  prepareExampleDataTable,
   PER_PAGE_COUNT,
+  exampleColumns,
+  prepareExampleDataTable,
   sortLanguagesByPreference,
-} from './utils'
-import { DocSdkExampleCell } from './DocSdkExampleCell'
+} from './utils';
+import { DocSdkExampleCell } from './DocSdkExampleCell';
 
 interface DocSdkUsageProps {
-  method: IMethod
+  method: IMethod;
 }
 
 /**
@@ -60,39 +60,40 @@ interface DocSdkUsageProps {
  *  links to the source files
  */
 export const DocSdkUsage: FC<DocSdkUsageProps> = ({ method }) => {
-  const examples = useSelector(selectExamplesLode)
-  const sdkLanguage = useSelector(selectSdkLanguage)
-  const [page, setPage] = useState(1)
+  const examples = useSelector(selectExamplesLode);
+  const sdkLanguage = useSelector(selectSdkLanguage);
+  const [page, setPage] = useState(1);
 
   useEffect(() => {
-    setPage(1)
-  }, [method])
+    setPage(1);
+  }, [method]);
 
-  if (!examples) return <></>
-  let languages = findExampleLanguages(examples, method.name)
-  if (languages.length === 0) return <></>
+  if (!examples) return <></>;
+  let languages = findExampleLanguages(examples, method.name);
+  if (languages.length === 0) return <></>;
 
-  languages = sortLanguagesByPreference(languages, sdkLanguage)
+  languages = sortLanguagesByPreference(languages, sdkLanguage);
 
   const { pageExamples, pageLimit, paginate } = prepareExampleDataTable(
     languages,
     examples,
     method.operationId,
     page
-  )
+  );
 
-  if (pageExamples.length === 0) return <></>
+  if (pageExamples.length === 0) return <></>;
 
   return (
     <CollapserCard id="examples" heading="SDK Examples">
       <Card height="auto" px="small" py="xsmall" mt="small">
         <DataTable caption="SDK Examples" columns={exampleColumns}>
           {pageExamples.map((exampleRow, i) => {
-            const isEmptyItem = exampleRow.filename === EMPTY_STRING
+            const isEmptyItem = exampleRow.filename === EMPTY_STRING;
             const isLastItem =
-              (i + 1) % PER_PAGE_COUNT === 0 || i + 1 === pageExamples.length
-            const nextItemEmpty = pageExamples[i + 1]?.filename === EMPTY_STRING
-            const hidden = isEmptyItem || isLastItem || nextItemEmpty
+              (i + 1) % PER_PAGE_COUNT === 0 || i + 1 === pageExamples.length;
+            const nextItemEmpty =
+              pageExamples[i + 1]?.filename === EMPTY_STRING;
+            const hidden = isEmptyItem || isLastItem || nextItemEmpty;
             return (
               <DataTableItem
                 id={exampleRow.permalink}
@@ -126,7 +127,7 @@ export const DocSdkUsage: FC<DocSdkUsageProps> = ({ method }) => {
                   {exampleRow.line}
                 </DocSdkExampleCell>
               </DataTableItem>
-            )
+            );
           })}
         </DataTable>
         {paginate && (
@@ -135,12 +136,12 @@ export const DocSdkUsage: FC<DocSdkUsageProps> = ({ method }) => {
               current={page}
               pages={pageLimit}
               onChange={(nextPage) => {
-                setPage(nextPage)
+                setPage(nextPage);
               }}
             />
           </Box>
         )}
       </Card>
     </CollapserCard>
-  )
-}
+  );
+};

package/src/components/DocSdkUsage/index.ts

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

package/src/components/DocSdkUsage/utils.ts

@@ -24,14 +24,14 @@
 
  */
 
-import type { IExampleMine } from '@looker/sdk-codegen'
-import { findExamples } from '@looker/sdk-codegen'
-import type { DataTableColumns } from '@looker/components'
-import { theme } from '@looker/components'
+import type { IExampleMine } from '@looker/sdk-codegen';
+import { findExamples } from '@looker/sdk-codegen';
+import type { DataTableColumns } from '@looker/components';
+import { theme } from '@looker/components';
 
-export const PER_PAGE_COUNT = 10
+export const PER_PAGE_COUNT = 10;
 
-export const EMPTY_STRING = ''
+export const EMPTY_STRING = '';
 
 export const exampleColumns: DataTableColumns = [
   {
@@ -58,23 +58,23 @@ export const exampleColumns: DataTableColumns = [
     type: 'number',
     size: 20,
   },
-]
+];
 
 export interface ExampleLinkTableRow {
-  filename: string
-  language: string
-  line: string
-  permalink: string
-  description: string
+  filename: string;
+  language: string;
+  line: string;
+  permalink: string;
+  description: string;
 }
 
 export interface DataTablePage {
   /** array of sdk examples for a given page */
-  pageExamples: ExampleLinkTableRow[]
+  pageExamples: ExampleLinkTableRow[];
   /** the page limit of the larger example set */
-  pageLimit: number
+  pageLimit: number;
   /** flag for whether or not to paginate results */
-  paginate: boolean
+  paginate: boolean;
 }
 
 /**
@@ -83,10 +83,10 @@ export interface DataTablePage {
  * @returns file name
  */
 export function getFileNameFromPath(path: string): string {
-  const lastForwardSlash = path.lastIndexOf('/')
+  const lastForwardSlash = path.lastIndexOf('/');
   return lastForwardSlash === -1
     ? path
-    : path.slice(lastForwardSlash + 1, path.indexOf(' '))
+    : path.slice(lastForwardSlash + 1, path.indexOf(' '));
 }
 
 /**
@@ -107,7 +107,7 @@ export function prepareExampleDataTable(
     result: ExampleLinkTableRow[],
     language: string
   ) {
-    const languageExamples = findExamples(examples, language, operationId)
+    const languageExamples = findExamples(examples, language, operationId);
     return [
       ...result,
       ...languageExamples.map((exampleLink) => {
@@ -117,21 +117,20 @@ export function prepareExampleDataTable(
           language: language.toLowerCase(),
           permalink: exampleLink.permalink,
           description: exampleLink.description,
-        }
+        };
       }),
-    ]
-  },
-  [])
+    ];
+  }, []);
 
   const pageExamples = tableExamples.filter(
     (example, index) =>
       example &&
       index + 1 > (currentPage - 1) * PER_PAGE_COUNT &&
       index + 1 <= currentPage * PER_PAGE_COUNT
-  )
+  );
 
-  const pageLimit = Math.ceil(tableExamples.length / PER_PAGE_COUNT)
-  const paginate = tableExamples.length > PER_PAGE_COUNT
+  const pageLimit = Math.ceil(tableExamples.length / PER_PAGE_COUNT);
+  const paginate = tableExamples.length > PER_PAGE_COUNT;
 
   if (tableExamples.length > PER_PAGE_COUNT) {
     while (pageExamples.length !== PER_PAGE_COUNT) {
@@ -141,10 +140,10 @@ export function prepareExampleDataTable(
         language: EMPTY_STRING,
         permalink: pageExamples.length.toString(),
         description: EMPTY_STRING,
-      })
+      });
     }
   }
-  return { pageExamples, pageLimit, paginate }
+  return { pageExamples, pageLimit, paginate };
 }
 
 /**
@@ -152,7 +151,7 @@ export function prepareExampleDataTable(
  * @param hide whether or not to hide bottom border
  */
 export function getTableItemBottomBorder(hide: boolean): string {
-  return hide ? 'none' : `solid 1px ${theme.colors.ui2}`
+  return hide ? 'none' : `solid 1px ${theme.colors.ui2}`;
 }
 
 /**
@@ -167,6 +166,6 @@ export function sortLanguagesByPreference(
   languages.some(
     (item, idx) =>
       item === sdkLanguage && languages.unshift(languages.splice(idx, 1)[0])
-  )
-  return languages
+  );
+  return languages;
 }