@looker/api-explorer 0.9.55 → 0.9.57

package/src/scenes/MethodScene/components/DocOperation.tsx

@@ -23,16 +23,16 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import type { IMethod } from '@looker/sdk-codegen'
-import { Code, Flex, SpaceVertical, Text } from '@looker/components'
-import { MethodBadge } from '@looker/run-it'
+import type { FC } from 'react';
+import React from 'react';
+import type { IMethod } from '@looker/sdk-codegen';
+import { Code, Flex, SpaceVertical, Text } from '@looker/components';
+import { MethodBadge } from '@looker/run-it';
 
-import { DocPseudo } from '../../../components'
+import { DocPseudo } from '../../../components';
 
 interface DocOperationProps {
-  method: IMethod
+  method: IMethod;
 }
 
 export const DocOperation: FC<DocOperationProps> = ({ method }) => (
@@ -51,4 +51,4 @@ export const DocOperation: FC<DocOperationProps> = ({ method }) => (
       </Flex>
     </MethodBadge>
   </SpaceVertical>
-)
+);

package/src/scenes/MethodScene/components/DocRequestBody.spec.tsx

@@ -24,27 +24,27 @@
 
  */
 
-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 { DocRequestBody } from './DocRequestBody'
+import { api } from '../../../test-data';
+import { DocRequestBody } from './DocRequestBody';
 
 describe('DocRequestBody', () => {
   test('it shows Request body for a method with a body type', () => {
-    const method = api.methods.create_dashboard
-    renderWithTheme(<DocRequestBody api={api} method={method} />)
+    const method = api.methods.create_dashboard;
+    renderWithTheme(<DocRequestBody api={api} method={method} />);
     expect(
       screen.getByText('Request body', { exact: false })
-    ).toBeInTheDocument()
-  })
+    ).toBeInTheDocument();
+  });
 
   test('it skips Request body for a method without a body type', () => {
-    const method = api.methods.dashboard
-    renderWithTheme(<DocRequestBody api={api} method={method} />)
+    const method = api.methods.dashboard;
+    renderWithTheme(<DocRequestBody api={api} method={method} />);
     expect(
       screen.queryByText('Request body', { exact: false })
-    ).not.toBeInTheDocument()
-  })
-})
+    ).not.toBeInTheDocument();
+  });
+});

package/src/scenes/MethodScene/components/DocRequestBody.tsx

@@ -23,15 +23,15 @@
  SOFTWARE.
 
  */
-import type { FC } from 'react'
-import React from 'react'
-import type { ApiModel, IMethod } from '@looker/sdk-codegen'
-import { CollapserCard } from '@looker/run-it'
-import { ExploreType } from '../../../components'
+import type { FC } from 'react';
+import React from 'react';
+import type { ApiModel, IMethod } from '@looker/sdk-codegen';
+import { CollapserCard } from '@looker/run-it';
+import { ExploreType } from '../../../components';
 
 interface DocRequestBodyProps {
-  method: IMethod
-  api: ApiModel
+  method: IMethod;
+  api: ApiModel;
 }
 
 /**
@@ -39,9 +39,9 @@ interface DocRequestBodyProps {
  * @param method to document
  */
 export const DocRequestBody: FC<DocRequestBodyProps> = ({ method, api }) => {
-  const bodies = method.bodyParams
-  if (bodies.length === 0) return <></>
-  const header = bodies.length > 1 ? 'Request bodies' : 'Request body'
+  const bodies = method.bodyParams;
+  if (bodies.length === 0) return <></>;
+  const header = bodies.length > 1 ? 'Request bodies' : 'Request body';
 
   return (
     <CollapserCard id="bodies" heading={header}>
@@ -56,5 +56,5 @@ export const DocRequestBody: FC<DocRequestBodyProps> = ({ method, api }) => {
         ))}
       </>
     </CollapserCard>
-  )
-}
+  );
+};

package/src/scenes/MethodScene/components/DocResponses/DocResponseTypes.tsx

@@ -24,20 +24,20 @@
 
  */
 
-import React, { useState, useEffect } from 'react'
-import { ButtonToggle, ButtonItem } from '@looker/components'
+import React, { useEffect, useState } from 'react';
+import { ButtonItem, ButtonToggle } from '@looker/components';
 import type {
   ApiModel,
-  KeyedCollection,
   IMethodResponse,
-} from '@looker/sdk-codegen'
+  KeyedCollection,
+} from '@looker/sdk-codegen';
 
-import { ExploreType } from '../../../../components'
+import { ExploreType } from '../../../../components';
 
 interface DocResponseTypesProps {
-  api: ApiModel
+  api: ApiModel;
   /** responses to render */
-  responses: KeyedCollection<IMethodResponse>
+  responses: KeyedCollection<IMethodResponse>;
 }
 
 /**
@@ -46,15 +46,15 @@ interface DocResponseTypesProps {
  * @param response
  */
 export const DocResponseTypes = ({ api, responses }: DocResponseTypesProps) => {
-  const mediaTypes = Object.keys(responses)
-  const [selectedMediaType, setSelectedMediaType] = useState(mediaTypes[0])
-  const [resps, setResps] = useState(responses)
+  const mediaTypes = Object.keys(responses);
+  const [selectedMediaType, setSelectedMediaType] = useState(mediaTypes[0]);
+  const [resps, setResps] = useState(responses);
 
   useEffect(() => {
     /** When new responses are passed, update the default selected media type */
-    setSelectedMediaType(mediaTypes[0])
-    setResps(responses)
-  }, [responses, mediaTypes])
+    setSelectedMediaType(mediaTypes[0]);
+    setResps(responses);
+  }, [responses, mediaTypes]);
 
   // TODO: Account for endpoints with no responses (e.g. delete a custom cmd)
   return (
@@ -79,5 +79,5 @@ export const DocResponseTypes = ({ api, responses }: DocResponseTypesProps) => {
         />
       </div>
     </>
-  )
-}
+  );
+};

package/src/scenes/MethodScene/components/DocResponses/DocResponses.spec.tsx

@@ -23,52 +23,52 @@
  SOFTWARE.
 
  */
-import React from 'react'
-import { screen, waitFor } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
+import React from 'react';
+import { screen, waitFor } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
 import {
   registerTestEnvAdaptor,
   unregisterEnvAdaptor,
-} from '@looker/extension-utils'
+} from '@looker/extension-utils';
 
-import { api } from '../../../../test-data'
-import { renderWithRouter } from '../../../../test-utils'
-import { DocResponses } from './DocResponses'
-import { buildResponseTree } from './utils'
+import { api } from '../../../../test-data';
+import { renderWithRouter } from '../../../../test-utils';
+import { DocResponses } from './DocResponses';
+import { buildResponseTree } from './utils';
 
 describe('DocResponses', () => {
   beforeAll(() => {
-    registerTestEnvAdaptor()
-  })
+    registerTestEnvAdaptor();
+  });
 
   afterAll(() => {
-    unregisterEnvAdaptor()
-  })
+    unregisterEnvAdaptor();
+  });
 
   test('it renders all response statuses and their types', async () => {
-    const responses = api.methods.run_look.responses
-    renderWithRouter(<DocResponses api={api} method={api.methods.run_look} />)
+    const responses = api.methods.run_look.responses;
+    renderWithRouter(<DocResponses api={api} method={api.methods.run_look} />);
 
-    expect(screen.getByText('Response Models')).toBeInTheDocument()
+    expect(screen.getByText('Response Models')).toBeInTheDocument();
 
-    const responseTree = buildResponseTree(responses)
-    const expectedRespStatuses = Object.keys(responseTree)
+    const responseTree = buildResponseTree(responses);
+    const expectedRespStatuses = Object.keys(responseTree);
     expect(
       screen.getAllByRole('tab', {
         name: new RegExp(`${expectedRespStatuses.join('|')}`),
       })
-    ).toHaveLength(expectedRespStatuses.length)
+    ).toHaveLength(expectedRespStatuses.length);
 
-    userEvent.click(screen.getByRole('tab', { name: '200: Look' }))
-    const successRespTypes = Object.keys(responseTree['200: Look'])
+    userEvent.click(screen.getByRole('tab', { name: '200: Look' }));
+    const successRespTypes = Object.keys(responseTree['200: Look']);
     await waitFor(() => {
       expect(
         screen.getAllByRole('button', {
           name: new RegExp(`${successRespTypes.join('|')}`),
         })
-      ).toHaveLength(successRespTypes.length)
-    })
-  })
+      ).toHaveLength(successRespTypes.length);
+    });
+  });
 
   test('selects tab corresponding to error code query param if present', async () => {
     const sampleIndex = {
@@ -78,7 +78,7 @@ describe('DocResponses', () => {
       '404/post/login': {
         url: 'login_404.md',
       },
-    }
+    };
 
     const badLoginMd = `## API Response 404 for \`login\`
 
@@ -86,7 +86,7 @@ describe('DocResponses', () => {
 
 A 404 Error response from the /login endpoint most often means that an attempt to login at a valid Looker URL was made but the combination of client_id and client_secret provided do not match an existing valid credential on that instance.
 
-See [HTTP 404 - Not Found](https://docs.looker.com/r/reference/looker-http-codes/404) for general information about this HTTP response from Looker.`
+See [HTTP 404 - Not Found](https://docs.looker.com/r/reference/looker-http-codes/404) for general information about this HTTP response from Looker.`;
 
     const mockResponse = async (val: string): Promise<Response> => {
       const resp: Response = {
@@ -96,58 +96,58 @@ See [HTTP 404 - Not Found](https://docs.looker.com/r/reference/looker-http-codes
         statusText: '',
         url: '',
         text(): Promise<string> {
-          return Promise.resolve(val)
+          return Promise.resolve(val);
         },
         status: 200,
         headers: {} as Headers,
         type: 'basic',
         clone: function (): Response {
-          throw new Error('Function not implemented.')
+          throw new Error('Function not implemented.');
         },
         body: null,
         arrayBuffer: function (): Promise<ArrayBuffer> {
-          throw new Error('Function not implemented.')
+          throw new Error('Function not implemented.');
         },
         blob: function (): Promise<Blob> {
-          throw new Error('Function not implemented.')
+          throw new Error('Function not implemented.');
         },
         formData: function (): Promise<FormData> {
-          throw new Error('Function not implemented.')
+          throw new Error('Function not implemented.');
         },
         json: function (): Promise<any> {
-          throw new Error('Function not implemented.')
+          throw new Error('Function not implemented.');
         },
-      } as unknown as Response
-      return Promise.resolve(resp)
-    }
-    const fetcher = global.fetch
+      } as unknown as Response;
+      return Promise.resolve(resp);
+    };
+    const fetcher = global.fetch;
     global.fetch = jest.fn((input: RequestInfo | URL, _init?: RequestInit) => {
-      const url = input.toString()
-      let result = 'I dunno'
+      const url = input.toString();
+      let result = 'I dunno';
       if (url.endsWith('index.json')) {
-        result = JSON.stringify(sampleIndex)
+        result = JSON.stringify(sampleIndex);
       }
       if (url.endsWith('login_404.md')) {
-        result = badLoginMd
+        result = badLoginMd;
       }
-      return mockResponse(result)
-    })
+      return mockResponse(result);
+    });
 
     renderWithRouter(
       <DocResponses api={api} method={api.methods.login} errorCode="404" />
-    )
-    expect(screen.getByText('Response Models')).toBeInTheDocument()
+    );
+    expect(screen.getByText('Response Models')).toBeInTheDocument();
 
     await waitFor(() => {
       expect(screen.getByRole('tab', { name: /^404: \w+/ })).toHaveAttribute(
         'aria-selected',
         'true'
-      )
-      expect(
-        screen.getByRole('heading', { name: 'Description' })
-      ).toBeInTheDocument()
-    })
+      );
+    });
+    expect(
+      screen.getByRole('heading', { name: 'Description' })
+    ).toBeInTheDocument();
 
-    global.fetch = fetcher
-  })
-})
+    global.fetch = fetcher;
+  });
+});

package/src/scenes/MethodScene/components/DocResponses/DocResponses.tsx

@@ -24,70 +24,70 @@
 
  */
 
-import React, { useEffect, useState } from 'react'
-import { Tabs2, Tab2 } from '@looker/components'
-import type { ApiModel, IMethod } from '@looker/sdk-codegen'
-import { CollapserCard } from '@looker/run-it'
-import { ErrorDoc } from '@looker/sdk-rtl'
+import React, { useEffect, useState } from 'react';
+import { Tab2, Tabs2 } from '@looker/components';
+import type { ApiModel, IMethod } from '@looker/sdk-codegen';
+import { CollapserCard } from '@looker/run-it';
+import { ErrorDoc } from '@looker/sdk-rtl';
 import {
-  apiErrorDisplayFetch,
   ExtMarkdown,
+  apiErrorDisplayFetch,
   getEnvAdaptor,
-} from '@looker/extension-utils'
+} from '@looker/extension-utils';
 
-import { DocResponseTypes } from './DocResponseTypes'
-import { buildResponseTree } from './utils'
+import { DocResponseTypes } from './DocResponseTypes';
+import { buildResponseTree } from './utils';
 
 interface DocResponsesProps {
-  api: ApiModel
-  method: IMethod
+  api: ApiModel;
+  method: IMethod;
   /** error code to display */
-  errorCode?: string
+  errorCode?: string;
 }
 
 /**
  * Renders a tab list and tab panels for different method response types
  */
 export const DocResponses = ({ api, method, errorCode }: DocResponsesProps) => {
-  const [errorContent, setErrorContent] = useState('')
-  const responses = method.responses
+  const [errorContent, setErrorContent] = useState('');
+  const responses = method.responses;
 
-  const responseTree = buildResponseTree(responses)
-  const tabNames = Object.keys(responseTree)
+  const responseTree = buildResponseTree(responses);
+  const tabNames = Object.keys(responseTree);
 
-  let defaultTabId = tabNames[0]
+  let defaultTabId = tabNames[0];
 
   if (errorCode) {
-    const pattern = new RegExp(`${errorCode}: \\w+`)
+    const pattern = new RegExp(`${errorCode}: \\w+`);
     tabNames.forEach((el) => {
       if (pattern.test(el)) {
-        defaultTabId = el
+        defaultTabId = el;
       }
-    })
+    });
   }
 
   useEffect(() => {
-    if (!errorCode) return
+    if (!errorCode) return;
 
     const getErrorContent = async () => {
       const docUrl = `/err/4.0/${errorCode}/${method.httpMethod.toLocaleLowerCase()}${
         method.endpoint
-      }`
-      const adaptor = getEnvAdaptor()
-      const errDoc = new ErrorDoc(adaptor.sdk, apiErrorDisplayFetch)
-      const content = await errDoc.content(docUrl)
-      setErrorContent(content)
-    }
-    getErrorContent()
-  }, [errorCode])
+      }`;
+      const adaptor = getEnvAdaptor();
+      const errDoc = new ErrorDoc(adaptor.sdk, apiErrorDisplayFetch);
+      const content = await errDoc.content(docUrl);
+      setErrorContent(content);
+    };
+    getErrorContent();
+  }, [errorCode]);
 
-  if (responses.length === 0) return <></>
+  if (responses.length === 0) return <></>;
 
   return (
     <CollapserCard heading="Response Models" id="response models">
       <Tabs2 defaultTabId={defaultTabId}>
         {Object.entries(responseTree).map(([statusCode, response]) => {
-          const errorTab = errorCode && statusCode === defaultTabId
+          const errorTab = errorCode && statusCode === defaultTabId;
           return (
             <Tab2 key={statusCode} id={statusCode} label={statusCode}>
               <DocResponseTypes api={api} responses={response} />
@@ -95,9 +95,9 @@ export const DocResponses = ({ api, method, errorCode }: DocResponsesProps) => {
                 <ExtMarkdown source={errorContent} />
               )}
             </Tab2>
-          )
+          );
         })}
       </Tabs2>
     </CollapserCard>
-  )
-}
+  );
+};

package/src/scenes/MethodScene/components/DocResponses/index.ts

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

package/src/scenes/MethodScene/components/DocResponses/utils.spec.ts

@@ -23,32 +23,37 @@
  SOFTWARE.
 
  */
-import { api } from '../../../../test-data'
-import { buildResponseTree } from './utils'
+import { api } from '../../../../test-data';
+import { buildResponseTree } from './utils';
 
 describe('DocResponses utils', () => {
   describe('buildResponseTree', () => {
     test('it builds a response tree', () => {
-      const method = api.methods.run_look
-      const responses = method.responses
-      const actual = buildResponseTree(responses)
+      const method = api.methods.run_look;
+      const responses = method.responses;
+      const actual = buildResponseTree(responses);
       const responseStatuses = [
         '200: Look',
         '400: Bad Request',
         '404: Not Found',
         '422: Validation Error',
         '429: Too Many Requests',
-      ]
-      const mediaTypes = ['text', 'application/json', 'image/png', 'image/jpeg']
-      expect(Object.keys(actual)).toEqual(responseStatuses)
+      ];
+      const mediaTypes = [
+        'text',
+        'application/json',
+        'image/png',
+        'image/jpeg',
+      ];
+      expect(Object.keys(actual)).toEqual(responseStatuses);
 
       responseStatuses.forEach((status) => {
-        expect(Object.keys(actual[status])).toEqual(mediaTypes)
-      })
+        expect(Object.keys(actual[status])).toEqual(mediaTypes);
+      });
 
       expect(actual['200: Look']['application/json']).toEqual(
         method.primaryResponse
-      )
-    })
-  })
-})
+      );
+    });
+  });
+});

package/src/scenes/MethodScene/components/DocResponses/utils.ts

@@ -24,7 +24,7 @@
 
  */
 
-import type { IMethodResponse, KeyedCollection } from '@looker/sdk-codegen'
+import type { IMethodResponse, KeyedCollection } from '@looker/sdk-codegen';
 
 /**
  * Given an array of method responses, group them by statusCode. The value of each status code is a collection of
@@ -34,11 +34,11 @@ import type { IMethodResponse, KeyedCollection } from '@looker/sdk-codegen'
 export const buildResponseTree = (
   responses: IMethodResponse[]
 ): KeyedCollection<KeyedCollection<IMethodResponse>> => {
-  const tree = {}
+  const tree: KeyedCollection<KeyedCollection<IMethodResponse>> = {};
   Object.values(responses).forEach((response) => {
-    const node = `${response.statusCode}: ${response.description}`
-    if (!(node in tree)) tree[node] = {}
-    tree[node][response.mediaType] = response
-  })
-  return tree
-}
+    const node = `${response.statusCode}: ${response.description}`;
+    if (!(node in tree)) tree[node] = {};
+    tree[node][response.mediaType] = response;
+  });
+  return tree;
+};

package/src/scenes/MethodScene/components/index.ts

@@ -23,6 +23,6 @@
  SOFTWARE.
 
  */
-export { DocOperation } from './DocOperation'
-export { DocRequestBody } from './DocRequestBody'
-export { DocResponses } from './DocResponses'
+export { DocOperation } from './DocOperation';
+export { DocRequestBody } from './DocRequestBody';
+export { DocResponses } from './DocResponses';

package/src/scenes/MethodScene/index.ts

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