@looker/api-explorer 0.9.55 → 0.9.59

package/src/scenes/DiffScene/DocDiff/DocDiff.tsx

@@ -23,7 +23,7 @@
  SOFTWARE.
 
  */
-import type { ApiModel, DiffRow } from '@looker/sdk-codegen'
+import type { ApiModel, DiffRow } from '@looker/sdk-codegen';
 import {
   Flex,
   Heading,
@@ -31,24 +31,24 @@ import {
   Space,
   SpaceVertical,
   Text,
-} from '@looker/components'
-import type { FC } from 'react'
-import React, { useState } from 'react'
-import { DiffItem } from './DiffItem'
+} from '@looker/components';
+import type { FC } from 'react';
+import React, { useState } from 'react';
+import { DiffItem } from './DiffItem';
 
 export interface DocDiffProps {
   /** Using delta because IntelliJ has bugs with 'diff' in a react app */
-  delta: DiffRow[]
+  delta: DiffRow[];
   /** Left side specKey */
-  leftKey: string
+  leftKey: string;
   /** Left side spec */
-  leftSpec: ApiModel
+  leftSpec: ApiModel;
   /** Right side specKey */
-  rightKey: string
+  rightKey: string;
   /** Right side spec */
-  rightSpec: ApiModel
+  rightSpec: ApiModel;
   /** Number of rows per page. Defaults to 15 */
-  pageSize?: number
+  pageSize?: number;
 }
 
 export const DocDiff: FC<DocDiffProps> = ({
@@ -59,12 +59,12 @@ export const DocDiff: FC<DocDiffProps> = ({
   rightSpec,
   pageSize = 15,
 }) => {
-  const [page, setPage] = useState(1)
+  const [page, setPage] = useState(1);
 
-  if (delta.length === 0) return <Text>{'No differences found'}</Text>
+  if (delta.length === 0) return <Text>{'No differences found'}</Text>;
 
-  const pageCount = Math.ceil(delta.length / pageSize)
-  const pageItemData = delta.slice((page - 1) * pageSize, page * pageSize)
+  const pageCount = Math.ceil(delta.length / pageSize);
+  const pageItemData = delta.slice((page - 1) * pageSize, page * pageSize);
 
   return (
     <>
@@ -91,11 +91,11 @@ export const DocDiff: FC<DocDiffProps> = ({
             current={page}
             pages={pageCount}
             onChange={(nextPage) => {
-              setPage(nextPage)
+              setPage(nextPage);
             }}
           />
         </Flex>
       )}
     </>
-  )
-}
+  );
+};

package/src/scenes/DiffScene/DocDiff/docDiffUtils.tsx

@@ -24,8 +24,8 @@
 
  */
 
-import type { ApiModel, DiffRow, ICodeGen } from '@looker/sdk-codegen'
-import { getCodeGenerator, PseudoGen } from '@looker/sdk-codegen'
+import type { ApiModel, DiffRow, ICodeGen } from '@looker/sdk-codegen';
+import { PseudoGen, getCodeGenerator } from '@looker/sdk-codegen';
 
 export const diffText = (
   row: DiffRow,
@@ -33,38 +33,38 @@ export const diffText = (
   api: ApiModel,
   sdkLanguage: string
 ) => {
-  let gen: ICodeGen
+  let gen: ICodeGen;
   if (sdkLanguage === 'All') {
-    gen = new PseudoGen(api)
+    gen = new PseudoGen(api);
   } else {
-    gen = getCodeGenerator(sdkLanguage, api)!
+    gen = getCodeGenerator(sdkLanguage, api)!;
   }
 
-  const method = api.methods[row.name]
-  if (!method) return `${row.name} is missing`
-  const indent = ''
-  let result = status ? `Status: ${status}\n` : ''
-  result += gen.methodSignature(indent, method)
+  const method = api.methods[row.name];
+  if (!method) return `${row.name} is missing`;
+  const indent = '';
+  let result = status ? `Status: ${status}\n` : '';
+  result += gen.methodSignature(indent, method);
   if (row.bodyDiff) {
     const args = method.bodyParams.map((p) =>
       gen.declareParameter(indent, method, p)
-    )
-    result += `\nBody:\n${args.join('\n')}`
+    );
+    result += `\nBody:\n${args.join('\n')}`;
   }
   if (row.typeDiff) {
-    result += `\nMethod type:\n${gen.declareType(indent, method.type)}`
+    result += `\nMethod type:\n${gen.declareType(indent, method.type)}`;
   }
   if (row.responseDiff) {
-    const bump = gen.bumper(indent)
+    const bump = gen.bumper(indent);
     const items = method.responses.map((r) => {
       return `${bump}Code: ${r.statusCode}
 ${bump}MIME: ${r.mediaType}
-${bump}Type:${r.type.fullName}`
-    })
-    result += `\nResponses:\n${items.join('\n')}`
+${bump}Type:${r.type.fullName}`;
+    });
+    result += `\nResponses:\n${items.join('\n')}`;
   }
-  return result
-}
+  return result;
+};
 
 export const differ = (
   row: DiffRow,
@@ -77,12 +77,12 @@ export const differ = (
     row.lStatus !== row.rStatus ? row.lStatus : '',
     leftSpec,
     sdkLanguage
-  )
+  );
   const rhs = diffText(
     row,
     row.lStatus !== row.rStatus ? row.rStatus : '',
     rightSpec,
     sdkLanguage
-  )
-  return { lhs, rhs }
-}
+  );
+  return { lhs, rhs };
+};

package/src/scenes/DiffScene/DocDiff/index.ts

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

package/src/scenes/DiffScene/diffUtils.spec.ts

@@ -24,10 +24,10 @@
 
  */
 
-import type { DiffRow } from '@looker/sdk-codegen'
-import { startCount } from '@looker/sdk-codegen'
-import { api, api40 } from '../../test-data'
-import { diffToSpec } from './diffUtils'
+import type { DiffRow } from '@looker/sdk-codegen';
+import { startCount } from '@looker/sdk-codegen';
+import { api, api40 } from '../../test-data';
+import { diffToSpec } from './diffUtils';
 
 describe('diffUtils', () => {
   test('builds a psuedo spec from diff', () => {
@@ -54,13 +54,13 @@ describe('diffUtils', () => {
         paramsDiff: '',
         responseDiff: '',
       },
-    ]
-    const spec = diffToSpec(delta, api, api40)
+    ];
+    const spec = diffToSpec(delta, api, api40);
     expect(Object.keys(spec.methods)).toEqual([
       'create_query',
       'search_dashboards',
-    ])
-    expect(Object.keys(spec.tags)).toEqual(['Query', 'Dashboard'])
-    expect(Object.keys(spec.types)).toEqual([])
-  })
-})
+    ]);
+    expect(Object.keys(spec.tags)).toEqual(['Query', 'Dashboard']);
+    expect(Object.keys(spec.types)).toEqual([]);
+  });
+});

package/src/scenes/DiffScene/diffUtils.ts

@@ -24,7 +24,7 @@
 
  */
 
-import cloneDeep from 'lodash/cloneDeep'
+import cloneDeep from 'lodash/cloneDeep';
 import type {
   DiffFilter,
   DiffRow,
@@ -32,8 +32,8 @@ import type {
   IMethod,
   MethodList,
   TagList,
-} from '@looker/sdk-codegen'
-import { compareSpecs } from '@looker/sdk-codegen'
+} from '@looker/sdk-codegen';
+import { compareSpecs } from '@looker/sdk-codegen';
 
 export const allDiffToggles = [
   'missing',
@@ -42,7 +42,7 @@ export const allDiffToggles = [
   'type',
   'body',
   'response',
-]
+];
 
 export const standardDiffToggles = [
   'missing',
@@ -50,7 +50,7 @@ export const standardDiffToggles = [
   'type',
   'body',
   'response',
-]
+];
 
 /**
  * Abstraction of compareAPIs in case we need to transform compareSpecs diff rows
@@ -69,10 +69,10 @@ export const diffSpecs = (
     (options.includes('params') && !!delta.paramsDiff) ||
     (options.includes('type') && !!delta.typeDiff) ||
     (options.includes('body') && !!delta.bodyDiff) ||
-    (options.includes('response') && !!delta.responseDiff)
+    (options.includes('response') && !!delta.responseDiff);
 
-  return compareSpecs(lhs, rhs, includeOptions)
-}
+  return compareSpecs(lhs, rhs, includeOptions);
+};
 
 /**
  * Local copy of private function from ApiModel
@@ -81,15 +81,15 @@ export const diffSpecs = (
  */
 const addMethodToTags = (tags: TagList, method: IMethod): TagList => {
   for (const tag of method.schema.tags) {
-    let list: MethodList = tags[tag]
+    let list: MethodList = tags[tag];
     if (!list) {
-      list = {}
-      tags[tag] = list
+      list = {};
+      tags[tag] = list;
     }
-    list[method.name] = method
+    list[method.name] = method;
   }
-  return tags
-}
+  return tags;
+};
 
 /**
  * Combine diff into a psuedo api spec that contains an established method for each diff result
@@ -102,19 +102,19 @@ export const diffToSpec = (
   lSpec: IApiModel,
   rSpec: IApiModel
 ) => {
-  const result = cloneDeep(lSpec)
-  result.tags = {}
-  result.methods = {}
+  const result = cloneDeep(lSpec);
+  result.tags = {};
+  result.methods = {};
 
   delta.forEach((row) => {
-    const name = row.name
-    let method = lSpec.methods[name]
-    if (!method) method = rSpec.methods[name]
-    result.methods[name] = method
-    addMethodToTags(result.tags, method)
-  })
+    const name = row.name;
+    let method = lSpec.methods[name];
+    if (!method) method = rSpec.methods[name];
+    result.methods[name] = method;
+    addMethodToTags(result.tags, method);
+  });
 
   // TODO diff types then we can populate this also
-  result.types = {}
-  return result
-}
+  result.types = {};
+  return result;
+};

package/src/scenes/DiffScene/index.ts

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

package/src/scenes/ErrorDetailScene/ErrorDetailScene.tsx

@@ -23,16 +23,16 @@
  SOFTWARE.
 
  */
-import { Redirect, useRouteMatch } from 'react-router-dom'
-import { getEnvAdaptor } from '@looker/extension-utils'
-import { ErrorDoc } from '@looker/sdk-rtl'
-import React from 'react'
-import type { IApiModel } from '@looker/sdk-codegen'
+import { Redirect, useRouteMatch } from 'react-router-dom';
+import { getEnvAdaptor } from '@looker/extension-utils';
+import { ErrorDoc } from '@looker/sdk-rtl';
+import React from 'react';
+import type { IApiModel } from '@looker/sdk-codegen';
 
-import { useNavigation } from '../../utils'
+import { useNavigation } from '../../utils';
 
 interface ErrorDetailSceneProps {
-  api: IApiModel
+  api: IApiModel;
 }
 
 /**
@@ -41,32 +41,32 @@ interface ErrorDetailSceneProps {
  */
 export const ErrorDetailScene = ({ api }: ErrorDetailSceneProps) => {
   const match = useRouteMatch<{
-    specKey: string
-    statusCode: string
-    verb: string
-  }>(`/:specKey/err/:statusCode/:verb/*`)
-  const methodPath = match?.params[0]
-  const adaptor = getEnvAdaptor()
-  const errorDoc = new ErrorDoc(adaptor.sdk)
-  const restPath = errorDoc.specPath(methodPath)
+    specKey: string;
+    statusCode: string;
+    verb: string;
+  }>(`/:specKey/err/:statusCode/:verb/*`);
+  const methodPath = match?.path ?? '';
+  const adaptor = getEnvAdaptor();
+  const errorDoc = new ErrorDoc(adaptor.sdk);
+  const restPath = errorDoc.specPath(methodPath);
 
-  const methodId = `${match?.params.verb} /${restPath}`.toLocaleLowerCase()
-  const specKey = match?.params.specKey
-  const statusCode = match?.params.statusCode
+  const methodId = `${match?.params.verb} /${restPath}`.toLocaleLowerCase();
+  const specKey = match?.params.specKey;
+  const statusCode = match?.params.statusCode;
 
   const method = Object.values(api.methods).find(
     (method) => method.id.toLocaleLowerCase() === methodId
-  )
+  );
 
-  const methodTag = method?.schema.tags[0]
-  const methodName = method?.operationId
+  const methodTag = method?.schema.tags[0];
+  const methodName = method?.operationId;
 
-  const { buildPathWithGlobalParams } = useNavigation()
+  const { buildPathWithGlobalParams } = useNavigation();
 
   const redirectPath = buildPathWithGlobalParams(
     `/${specKey}/methods/${methodTag}/${methodName}`,
     { e: statusCode }
-  )
+  );
 
-  return <Redirect to={redirectPath} />
-}
+  return <Redirect to={redirectPath} />;
+};

package/src/scenes/ErrorDetailScene/index.ts

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

package/src/scenes/HomeScene/HomeScene.tsx

@@ -23,24 +23,24 @@
  SOFTWARE.
 
  */
-import type { ApiModel } from '@looker/sdk-codegen'
-import type { FC } from 'react'
-import React from 'react'
-import { useParams } from 'react-router-dom'
-import { Space, Span, Tooltip } from '@looker/components'
-import { ApixSection, DocMarkdown, DocTitle } from '../../components'
+import type { ApiModel } from '@looker/sdk-codegen';
+import type { FC } from 'react';
+import React from 'react';
+import { useParams } from 'react-router-dom';
+import { Space, Span, Tooltip } from '@looker/components';
+import { ApixSection, DocMarkdown, DocTitle } from '../../components';
 
 interface DocHomeProps {
-  api: ApiModel
+  api: ApiModel;
 }
 
 interface DocHomeParams {
-  specKey: string
+  specKey: string;
 }
 
 export const HomeScene: FC<DocHomeProps> = ({ api }) => {
-  const { specKey } = useParams<DocHomeParams>()
-  const lookerVersion = 'x-looker-release-version'
+  const { specKey } = useParams<DocHomeParams>();
+  const lookerVersion = 'x-looker-release-version';
 
   return (
     <ApixSection>
@@ -56,5 +56,5 @@ export const HomeScene: FC<DocHomeProps> = ({ api }) => {
         <DocMarkdown source={api.spec.info.description} specKey={specKey} />
       )}
     </ApixSection>
-  )
-}
+  );
+};

package/src/scenes/HomeScene/index.ts

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

package/src/scenes/MethodScene/MethodScene.tsx

@@ -24,26 +24,26 @@
 
  */
 
-import type { FC } from 'react'
-import React, { useState, useEffect, useRef } from 'react'
+import type { FC } from 'react';
+import React, { useEffect, useRef, useState } from 'react';
 import {
   Aside,
   Button,
   ButtonOutline,
-  Space,
-  useToggle,
   ExtendComponentsThemeProvider,
+  Space,
   Span,
-} from '@looker/components'
-import { Beaker } from '@looker/icons'
-import { useHistory, useParams } from 'react-router-dom'
-import { RunIt, RunItFormKey } from '@looker/run-it'
-import type { ApiModel } from '@looker/sdk-codegen'
-import { typeRefs } from '@looker/sdk-codegen'
-import { useSelector } from 'react-redux'
-import type { IEnvironmentAdaptor } from '@looker/extension-utils'
-
-import { getApixAdaptor, useNavigation, useQuery } from '../../utils'
+  useToggle,
+} from '@looker/components';
+import { Beaker } from '@looker/icons';
+import { useHistory, useParams } from 'react-router-dom';
+import { RunIt, RunItFormKey } from '@looker/run-it';
+import type { ApiModel } from '@looker/sdk-codegen';
+import { typeRefs } from '@looker/sdk-codegen';
+import { useSelector } from 'react-redux';
+import type { IEnvironmentAdaptor } from '@looker/extension-utils';
+
+import { getApixAdaptor, useNavigation, useQuery } from '../../utils';
 import {
   ApixSection,
   DocActivityType,
@@ -51,82 +51,82 @@ import {
   DocRateLimited,
   DocReferences,
   DocSDKs,
+  DocSchema,
   DocSdkUsage,
   DocSource,
   DocStatus,
   DocTitle,
-  DocSchema,
-} from '../../components'
-import { selectSdkLanguage } from '../../state'
-import { DocOperation, DocRequestBody, DocResponses } from './components'
+} from '../../components';
+import { selectSdkLanguage } from '../../state';
+import { DocOperation, DocRequestBody, DocResponses } from './components';
 
 interface MethodSceneProps {
-  api: ApiModel
+  api: ApiModel;
 }
 
 interface MethodSceneParams {
-  methodName: string
-  methodTag: string
-  specKey: string
+  methodName: string;
+  methodTag: string;
+  specKey: string;
 }
 
 const showRunIt = async (adaptor: IEnvironmentAdaptor) => {
-  const data = await adaptor.localStorageGetItem(RunItFormKey)
-  return !!data
-}
+  const data = await adaptor.localStorageGetItem(RunItFormKey);
+  return !!data;
+};
 
 export const MethodScene: FC<MethodSceneProps> = ({ api }) => {
-  const adaptor = getApixAdaptor()
-  const history = useHistory()
-  const { navigate } = useNavigation()
-  const sdkLanguage = useSelector(selectSdkLanguage)
-  const { specKey, methodTag, methodName } = useParams<MethodSceneParams>()
-  const { value, toggle, setOn } = useToggle()
-  const [method, setMethod] = useState(api.methods[methodName])
-  const seeTypes = typeRefs(api, method?.customTypes)
-  const query = useQuery()
-  const errorCode = query.get('e') ?? undefined
-  const RunItButton = value ? Button : ButtonOutline
-  const docResponsesRef = useRef<HTMLElement>(null)
+  const adaptor = getApixAdaptor();
+  const history = useHistory();
+  const { navigate } = useNavigation();
+  const sdkLanguage = useSelector(selectSdkLanguage);
+  const { specKey, methodTag, methodName } = useParams<MethodSceneParams>();
+  const { value, toggle, setOn } = useToggle();
+  const [method, setMethod] = useState(api.methods[methodName]);
+  const seeTypes = typeRefs(api, method?.customTypes);
+  const query = useQuery();
+  const errorCode = query.get('e') ?? undefined;
+  const RunItButton = value ? Button : ButtonOutline;
+  const docResponsesRef = useRef<HTMLElement>(null);
 
   useEffect(() => {
-    const foundMethod = api.methods[methodName]
+    const foundMethod = api.methods[methodName];
     if (foundMethod) {
-      setMethod(api.methods[methodName])
+      setMethod(api.methods[methodName]);
     } else {
       // Invalid method
       if (api.tags[methodTag]) {
         // Found tag though
-        navigate(`/${specKey}/methods/${methodTag}`)
+        navigate(`/${specKey}/methods/${methodTag}`);
       } else {
-        navigate(`/${specKey}/methods`)
+        navigate(`/${specKey}/methods`);
       }
     }
-  }, [api, history, methodName, methodTag, specKey])
+  }, [api, history, methodName, methodTag, specKey]);
 
   useEffect(() => {
     const checkRunIt = async () => {
       try {
-        const show = await showRunIt(adaptor)
+        const show = await showRunIt(adaptor);
         if (show) {
-          setOn()
+          setOn();
         }
       } catch (error) {
-        console.error(error)
+        console.error(error);
       }
-    }
-    checkRunIt()
-  }, [adaptor, setOn])
+    };
+    checkRunIt();
+  }, [adaptor, setOn]);
 
   useEffect(() => {
     if (method?.responses && errorCode) {
       if (docResponsesRef.current) {
         window.setTimeout(() => {
-          docResponsesRef.current!.scrollIntoView()
-        }, 300)
+          docResponsesRef.current!.scrollIntoView();
+        }, 300);
       }
     }
-  }, [method])
+  }, [method]);
 
   const runItToggle = (
     <RunItButton
@@ -136,7 +136,7 @@ export const MethodScene: FC<MethodSceneProps> = ({ api }) => {
     >
       Run It
     </RunItButton>
-  )
+  );
 
   return (
     <>
@@ -190,5 +190,5 @@ export const MethodScene: FC<MethodSceneProps> = ({ api }) => {
         </Aside>
       )}
     </>
-  )
-}
+  );
+};

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

@@ -23,31 +23,31 @@
  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 { DocOperation } from './DocOperation'
+import { api } from '../../../test-data';
+import { DocOperation } from './DocOperation';
 
 describe('DocOperation', () => {
-  const method = api.methods.create_dashboard
+  const method = api.methods.create_dashboard;
 
   test('it renders SDK portion of a method', () => {
-    renderWithTheme(<DocOperation method={method} />)
-    expect(screen.getByText(method.name, { exact: false })).toBeInTheDocument()
+    renderWithTheme(<DocOperation method={method} />);
+    expect(screen.getByText(method.name, { exact: false })).toBeInTheDocument();
     method.allParams.forEach((param) => {
-      expect(screen.getByText(param.name)).toBeInTheDocument()
-    })
+      expect(screen.getByText(param.name)).toBeInTheDocument();
+    });
 
     expect(
       screen.getByText(method.primaryResponse.type.name)
-    ).toBeInTheDocument()
-  })
+    ).toBeInTheDocument();
+  });
 
   test('it renders HTTP portion of a method', () => {
-    renderWithTheme(<DocOperation method={method} />)
-    expect(screen.getByText(method.httpMethod)).toBeInTheDocument()
-    expect(screen.getByText(method.endpoint)).toBeInTheDocument()
-  })
-})
+    renderWithTheme(<DocOperation method={method} />);
+    expect(screen.getByText(method.httpMethod)).toBeInTheDocument();
+    expect(screen.getByText(method.endpoint)).toBeInTheDocument();
+  });
+});