@looker/api-explorer 0.9.35 → 0.9.36

package/src/utils/hooks.spec.ts

@@ -0,0 +1,78 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { useHistory } from 'react-router-dom'
+import { useNavigation } from './hooks'
+
+const mockHistoryPush = jest.fn()
+jest.mock('react-router-dom', () => {
+  const ReactRouterDOM = jest.requireActual('react-router-dom')
+  return {
+    ...ReactRouterDOM,
+    useHistory: () => ({
+      push: mockHistoryPush,
+      location: { pathname: '/3.1/methods', search: 's=test' },
+    }),
+  }
+})
+
+describe('Navigate', () => {
+  const history = useHistory()
+  const navigate = useNavigation()
+  const curParams = new URLSearchParams(history.location.search) // 's=test'
+  const route = `/3.1`
+
+  test('preserves existing query params when given params are undefined', () => {
+    navigate(route)
+    expect(curParams.get('s')).toBe('test')
+    expect(mockHistoryPush).lastCalledWith({
+      pathname: route,
+      search: curParams.toString(),
+    })
+  })
+
+  test('clears existing params when given params are null', () => {
+    navigate(route, null)
+    expect(mockHistoryPush).lastCalledWith({
+      pathname: route,
+    })
+  })
+
+  test('clears existing params when given params are an empty object', () => {
+    navigate(route, {})
+    expect(mockHistoryPush).lastCalledWith({
+      pathname: route,
+    })
+  })
+
+  test('sets query parameters when given a populated query params object', () => {
+    const newParams = 's=embedsso'
+    navigate(route, { search: newParams })
+    expect(mockHistoryPush).lastCalledWith({
+      pathname: route,
+      search: newParams,
+    })
+  })
+})

package/src/utils/hooks.ts

@@ -0,0 +1,53 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { useHistory } from 'react-router-dom'
+
+/**
+ * Hook for navigating to given route with specified query params
+ *
+ * @param path Pathname to navigate to
+ * @param queryParams Hash of query param name/value pairs to include in the destination url
+ */
+
+export const useNavigation = () => {
+  const history = useHistory()
+
+  const navigate = (path: string, queryParams?: { search?: string } | null) => {
+    if (queryParams === undefined) {
+      // if params passed in is undefined, maintain existing parameters in the URL
+      const curParams = new URLSearchParams(history.location.search)
+      history.push({ pathname: path, search: curParams.toString() })
+    } else if (queryParams === null || Object.keys(queryParams).length === 0) {
+      // if params passed in is null or empty, remove all parameters from the URL
+      history.push({ pathname: path })
+    } else {
+      // if we have new parameters passed in, push them to the URL
+      history.push({ pathname: path, search: queryParams.search })
+    }
+  }
+
+  return navigate
+}

package/src/utils/index.ts

@@ -29,3 +29,4 @@ export { getLoded } from './lodeUtils'
 export { useWindowSize } from './useWindowSize'
 export * from './apixAdaptor'
 export * from './adaptorUtils'
+export { useNavigation } from './hooks'

package/src/utils/path.spec.ts

@@ -28,16 +28,39 @@ import { api } from '../test-data'
 import { buildMethodPath, buildPath, buildTypePath } from './path'
 
 describe('path utils', () => {
+  const testParam = 's=test'
   describe('buildMethodPath', () => {
     test('it builds a method path', () => {
       const path = buildMethodPath('3.1', 'Dashboard', 'create_dashboard')
       expect(path).toEqual('/3.1/methods/Dashboard/create_dashboard')
     })
+    test('it builds a method path with params', () => {
+      const path = buildMethodPath(
+        '3.1',
+        'Dashboard',
+        'create_dashboard',
+        testParam
+      )
+      expect(path).toEqual(
+        `/3.1/methods/Dashboard/create_dashboard?${testParam}`
+      )
+    })
   })
 
   describe('buildTypePath', () => {
-    const path = buildTypePath('3.1', 'Dashboard', 'WriteDashboard')
-    expect(path).toEqual('/3.1/types/Dashboard/WriteDashboard')
+    test('it builds a type path', () => {
+      const path = buildTypePath('3.1', 'Dashboard', 'WriteDashboard')
+      expect(path).toEqual('/3.1/types/Dashboard/WriteDashboard')
+    })
+    test('it builds a type path with params', () => {
+      const path = buildTypePath(
+        '3.1',
+        'Dashboard',
+        'create_dashboard',
+        testParam
+      )
+      expect(path).toEqual(`/3.1/types/Dashboard/create_dashboard?${testParam}`)
+    })
   })
 
   describe('buildPath', () => {

package/src/utils/path.ts

@@ -33,23 +33,30 @@ import type { Location as HLocation } from 'history'
  * @param specKey A string to identify the spec in the URL
  * @param tag Corresponding method tag
  * @param methodName A method name
+ * @param params Hash of query param name/value pairs to include in the destination url
  * @returns a Method path
  */
 export const buildMethodPath = (
   specKey: string,
   tag: string,
-  methodName: string
-) => `/${specKey}/methods/${tag}/${methodName}`
+  methodName: string,
+  params?: string
+) => `/${specKey}/methods/${tag}/${methodName}${params ? `?${params}` : ''}`
 
 /**
  * Builds a path matching the route used by TypeScene
  * @param specKey A string to identify the spec in the URL
  * @param tag Corresponding type tag
  * @param typeName A type name
+ * @param params Hash of query param name/value pairs to include in the destination url
  * @returns a Type path
  */
-export const buildTypePath = (specKey: string, tag: string, typeName: string) =>
-  `/${specKey}/types/${tag}/${typeName}`
+export const buildTypePath = (
+  specKey: string,
+  tag: string,
+  typeName: string,
+  params?: string
+) => `/${specKey}/types/${tag}/${typeName}${params ? `?${params}` : ''}`
 
 export const diffPath = 'diff'
 export const oAuthPath = 'oauth'