@looker/api-explorer 0.9.38 → 0.9.40

package/src/components/DocMethodSummary/DocSummaryStatus.spec.tsx

@@ -33,7 +33,7 @@ import { DocSummaryStatus } from './DocSummaryStatus'
 describe('DocMethodSummaryStatus', () => {
   test.each`
     status          | method                              | expectedLabel        | expectedContent
-    ${'beta'}       | ${api40.methods.workspace}          | ${'beta item'}       | ${'This beta item is under development and subject to change.'}
+    ${'beta'}       | ${api40.methods.invalidate_tokens}  | ${'beta item'}       | ${'This beta item is under development and subject to change.'}
     ${'stable'}     | ${api.methods.login}                | ${'stable item'}     | ${'This item is considered stable for this API version.'}
     ${'deprecated'} | ${api.methods.backup_configuration} | ${'deprecated item'} | ${'This item has been deprecated and will be removed in the future.'}
   `(

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

@@ -28,6 +28,7 @@ import { pickTooltipContent } from './utils'
 describe('DocMethodSummary utils', () => {
   test.each`
     status            | expected
+    ${'alpha'}        | ${'This alpha item is either for internal use, or not fully developed and may be significantly changed or completely removed in future releases.'}
     ${'beta'}         | ${'This beta item is under development and subject to change.'}
     ${'experimental'} | ${'This experimental item is not fully developed and may be significantly changed or completely removed in future releases.'}
     ${'deprecated'}   | ${'This item has been deprecated and will be removed in the future.'}

package/src/components/DocMethodSummary/utils.tsx

@@ -68,6 +68,8 @@ export const pickStatus = (status: string) => {
  */
 export const pickTooltipContent = (status: string) => {
   switch (status.toLowerCase()) {
+    case 'alpha':
+      return 'This alpha item is either for internal use, or not fully developed and may be significantly changed or completely removed in future releases.'
     case 'beta':
       return 'This beta item is under development and subject to change.'
     case 'experimental':

package/src/components/DocStatus/DocStatus.spec.tsx

@@ -32,7 +32,7 @@ import { DocStatus } from './DocStatus'
 
 describe('DocStatus', () => {
   test('it renders a badge with the status and a tooltip on hover', async () => {
-    renderWithTheme(<DocStatus method={api40.methods.create_dashboard} />)
+    renderWithTheme(<DocStatus method={api40.methods.invalidate_tokens} />)
     const badge = screen.getByText('BETA')
     fireEvent.mouseOver(badge)
     await waitFor(() => {

package/src/components/SelectorContainer/SdkLanguageSelector.tsx

@@ -27,6 +27,7 @@ import type { FC } from 'react'
 import React, { useEffect, useState } from 'react'
 import { Select } from '@looker/components'
 import { useSelector } from 'react-redux'
+import { useLocation } from 'react-router-dom'
 import { selectSdkLanguage } from '../../state'
 import { allAlias, useNavigation } from '../../utils'
 import { allSdkLanguageOptions } from './utils'
@@ -35,6 +36,7 @@ import { allSdkLanguageOptions } from './utils'
  * Allows the user to select their preferred SDK language
  */
 export const SdkLanguageSelector: FC = () => {
+  const location = useLocation()
   const { navigate } = useNavigation()
   const selectedSdkLanguage = useSelector(selectSdkLanguage)
   const [language, setLanguage] = useState(selectedSdkLanguage)

package/src/scenes/MethodScene/MethodScene.tsx

@@ -119,7 +119,7 @@ export const MethodScene: FC<MethodSceneProps> = ({ api }) => {
   }, [adaptor, setOn])
 
   useEffect(() => {
-    if (method.responses && errorCode) {
+    if (method?.responses && errorCode) {
       if (docResponsesRef.current) {
         window.setTimeout(() => {
           docResponsesRef.current!.scrollIntoView()

package/src/scenes/MethodTagScene/MethodTagScene.spec.tsx

@@ -41,7 +41,9 @@ jest.mock('react-router-dom', () => {
     ...ReactRouterDOM,
     useHistory: () => ({
       push: mockHistoryPush,
-      location,
+      location: {
+        pathname: '/4.0/methods/Look',
+      },
     }),
   }
 })
@@ -54,7 +56,7 @@ describe('MethodTagScene', () => {
       <Route path="/:specKey/methods/:methodTag">
         <MethodTagScene api={api} />
       </Route>,
-      ['/3.1/methods/ColorCollection']
+      ['/4.0/methods/ColorCollection']
     )
     expect(
       screen.getAllByRole('button', {
@@ -68,7 +70,7 @@ describe('MethodTagScene', () => {
       screen.getByText('/color_collections/standard').closest('a')
     ).toHaveAttribute(
       'href',
-      '/3.1/methods/ColorCollection/color_collections_standard'
+      '/4.0/methods/ColorCollection/color_collections_standard'
     )
   })
 
@@ -78,7 +80,7 @@ describe('MethodTagScene', () => {
       <Route path="/:specKey/methods/:methodTag">
         <MethodTagScene api={api} />
       </Route>,
-      ['/3.1/methods/ApiAuth']
+      ['/4.0/methods/ApiAuth']
     )
     expect(
       screen.getAllByRole('button', {
@@ -88,17 +90,18 @@ describe('MethodTagScene', () => {
   })
 
   test('it pushes filter to URL on toggle', async () => {
+    const site = '/4.0/methods/Look'
     renderWithRouterAndReduxProvider(
       <Route path="/:specKey/methods/:methodTag">
         <MethodTagScene api={api} />
       </Route>,
-      ['/3.1/methods/Look']
+      [site]
     )
     /** Filter by GET operation */
     userEvent.click(screen.getByRole('button', { name: 'GET' }))
     await waitFor(() => {
       expect(mockHistoryPush).toHaveBeenCalledWith({
-        pathname: location.pathname,
+        pathname: site,
         search: 't=get',
       })
     })
@@ -107,7 +110,7 @@ describe('MethodTagScene', () => {
     await waitFor(() => {
       // eslint-disable-next-line jest-dom/prefer-in-document
       expect(mockHistoryPush).toHaveBeenCalledWith({
-        pathname: location.pathname,
+        pathname: site,
         search: 't=delete',
       })
     })

package/src/scenes/MethodTagScene/MethodTagScene.tsx

@@ -25,7 +25,7 @@
  */
 import type { FC } from 'react'
 import React, { useEffect, useState } from 'react'
-import { useHistory, useParams } from 'react-router-dom'
+import { useHistory, useLocation, useParams } from 'react-router-dom'
 import { Grid, ButtonToggle, ButtonItem } from '@looker/components'
 import type { ApiModel } from '@looker/sdk-codegen'
 import { useSelector } from 'react-redux'
@@ -46,6 +46,7 @@ interface MethodTagSceneParams {
 
 export const MethodTagScene: FC<MethodTagSceneProps> = ({ api }) => {
   const { specKey, methodTag } = useParams<MethodTagSceneParams>()
+  const location = useLocation()
   const history = useHistory()
   const methods = api.tags[methodTag]
   const { navigate, buildPathWithGlobalParams, navigateWithGlobalParams } =

package/src/scenes/TypeTagScene/TypeTagScene.spec.tsx

@@ -35,28 +35,33 @@ import { TypeTagScene } from './TypeTagScene'
 const opBtnNames = /ALL|SPECIFICATION|WRITE|REQUEST|ENUMERATED/
 
 const path = '/:specKey/types/:typeTag'
-
 const mockHistoryPush = jest.fn()
 jest.mock('react-router-dom', () => {
   const ReactRouterDOM = jest.requireActual('react-router-dom')
   return {
     ...ReactRouterDOM,
+    useLocation: () => ({
+      pathname: '/4.0/types/Look',
+    }),
     useHistory: () => ({
       push: mockHistoryPush,
-      location,
+      location: {
+        pathname: '/4.0/types/Look',
+      },
     }),
   }
 })
 
 describe('TypeTagScene', () => {
   Element.prototype.scrollTo = jest.fn()
+  // const mockHistoryPush: jest.Mock = useHistory as jest.Mock
 
   test('it renders type buttons and all methods for a given type tag', () => {
     renderWithRouterAndReduxProvider(
       <Route path={path}>
         <TypeTagScene api={api} />
       </Route>,
-      ['/3.1/types/Dashboard']
+      ['/4.0/types/Dashboard']
     )
     expect(
       screen.getAllByRole('button', {
@@ -68,7 +73,7 @@ describe('TypeTagScene', () => {
     )
     expect(screen.getByText('DashboardBase').closest('a')).toHaveAttribute(
       'href',
-      '/3.1/types/Dashboard/DashboardBase'
+      '/4.0/types/Dashboard/DashboardBase'
     )
   })
 
@@ -77,7 +82,7 @@ describe('TypeTagScene', () => {
       <Route path={path}>
         <TypeTagScene api={api} />
       </Route>,
-      ['/3.1/types/DataAction']
+      ['/4.0/types/DataAction']
     )
     expect(
       screen.getAllByRole('button', {
@@ -87,17 +92,18 @@ describe('TypeTagScene', () => {
   })
 
   test('it pushes filter to URL on toggle', async () => {
+    const site = '/4.0/types/Look'
     renderWithRouterAndReduxProvider(
       <Route path={path}>
         <TypeTagScene api={api} />
       </Route>,
-      ['/3.1/types/Look']
+      [site]
     )
     /** Filter by SPECIFICATION */
     userEvent.click(screen.getByRole('button', { name: 'SPECIFICATION' }))
     await waitFor(() => {
       expect(mockHistoryPush).toHaveBeenCalledWith({
-        pathname: location.pathname,
+        pathname: site,
         search: 't=specification',
       })
     })
@@ -105,7 +111,7 @@ describe('TypeTagScene', () => {
     userEvent.click(screen.getByRole('button', { name: 'REQUEST' }))
     await waitFor(() => {
       expect(mockHistoryPush).toHaveBeenCalledWith({
-        pathname: location.pathname,
+        pathname: site,
         search: 't=request',
       })
     })

package/src/scenes/TypeTagScene/TypeTagScene.tsx

@@ -27,7 +27,7 @@ import type { FC } from 'react'
 import React, { useEffect, useState } from 'react'
 import { Grid, ButtonToggle, ButtonItem } from '@looker/components'
 import type { ApiModel } from '@looker/sdk-codegen'
-import { useParams } from 'react-router-dom'
+import { useLocation, useParams } from 'react-router-dom'
 import { useSelector } from 'react-redux'
 import { ApixSection, DocTitle, DocTypeSummary, Link } from '../../components'
 import { buildTypePath, isValidFilter, useNavigation } from '../../utils'
@@ -46,6 +46,7 @@ interface TypeTagSceneParams {
 
 export const TypeTagScene: FC<TypeTagSceneProps> = ({ api }) => {
   const { specKey, typeTag } = useParams<TypeTagSceneParams>()
+  const location = useLocation()
   const { navigate, buildPathWithGlobalParams, navigateWithGlobalParams } =
     useNavigation()
   const selectedTagFilter = useSelector(selectTagFilter)