@looker/api-explorer 0.9.36 → 0.9.37

package/lib/utils/hooks.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useNavigation = void 0;
-
-var _reactRouterDom = require("react-router-dom");
-
-var useNavigation = () => {
-  var history = (0, _reactRouterDom.useHistory)();
-
-  var navigate = (path, queryParams) => {
-    if (queryParams === undefined) {
-      var curParams = new URLSearchParams(history.location.search);
-      history.push({
-        pathname: path,
-        search: curParams.toString()
-      });
-    } else if (queryParams === null || Object.keys(queryParams).length === 0) {
-      history.push({
-        pathname: path
-      });
-    } else {
-      history.push({
-        pathname: path,
-        search: queryParams.search
-      });
-    }
-  };
-
-  return navigate;
-};
-
-exports.useNavigation = useNavigation;
-//# sourceMappingURL=hooks.js.map

package/lib/utils/hooks.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/hooks.ts"],"names":["useNavigation","history","navigate","path","queryParams","undefined","curParams","URLSearchParams","location","search","push","pathname","toString","Object","keys","length"],"mappings":";;;;;;;AAyBA;;AASO,IAAMA,aAAa,GAAG,MAAM;AACjC,MAAMC,OAAO,GAAG,iCAAhB;;AAEA,MAAMC,QAAQ,GAAG,CAACC,IAAD,EAAeC,WAAf,KAA4D;AAC3E,QAAIA,WAAW,KAAKC,SAApB,EAA+B;AAE7B,UAAMC,SAAS,GAAG,IAAIC,eAAJ,CAAoBN,OAAO,CAACO,QAAR,CAAiBC,MAArC,CAAlB;AACAR,MAAAA,OAAO,CAACS,IAAR,CAAa;AAAEC,QAAAA,QAAQ,EAAER,IAAZ;AAAkBM,QAAAA,MAAM,EAAEH,SAAS,CAACM,QAAV;AAA1B,OAAb;AACD,KAJD,MAIO,IAAIR,WAAW,KAAK,IAAhB,IAAwBS,MAAM,CAACC,IAAP,CAAYV,WAAZ,EAAyBW,MAAzB,KAAoC,CAAhE,EAAmE;AAExEd,MAAAA,OAAO,CAACS,IAAR,CAAa;AAAEC,QAAAA,QAAQ,EAAER;AAAZ,OAAb;AACD,KAHM,MAGA;AAELF,MAAAA,OAAO,CAACS,IAAR,CAAa;AAAEC,QAAAA,QAAQ,EAAER,IAAZ;AAAkBM,QAAAA,MAAM,EAAEL,WAAW,CAACK;AAAtC,OAAb;AACD;AACF,GAZD;;AAcA,SAAOP,QAAP;AACD,CAlBM","sourcesContent":["/*\n\n MIT License\n\n Copyright (c) 2022 Looker Data Sciences, Inc.\n\n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n\n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n\n */\nimport { useHistory } from 'react-router-dom'\n\n/**\n * Hook for navigating to given route with specified query params\n *\n * @param path Pathname to navigate to\n * @param queryParams Hash of query param name/value pairs to include in the destination url\n */\n\nexport const useNavigation = () => {\n  const history = useHistory()\n\n  const navigate = (path: string, queryParams?: { search?: string } | null) => {\n    if (queryParams === undefined) {\n      // if params passed in is undefined, maintain existing parameters in the URL\n      const curParams = new URLSearchParams(history.location.search)\n      history.push({ pathname: path, search: curParams.toString() })\n    } else if (queryParams === null || Object.keys(queryParams).length === 0) {\n      // if params passed in is null or empty, remove all parameters from the URL\n      history.push({ pathname: path })\n    } else {\n      // if we have new parameters passed in, push them to the URL\n      history.push({ pathname: path, search: queryParams.search })\n    }\n  }\n\n  return navigate\n}\n"],"file":"hooks.js"}

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

@@ -1,60 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 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 React from 'react'
-import { screen, waitFor } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
-
-import { api } from '../../test-data'
-import { renderWithRouter } from '../../test-utils'
-import { DocResponses } from './DocResponses'
-import { buildResponseTree } from './utils'
-
-describe('DocResponses', () => {
-  test('it renders all response statuses and their types', async () => {
-    const responses = api.methods.run_look.responses
-    renderWithRouter(<DocResponses api={api} responses={responses} />)
-
-    expect(screen.getByText('Response Models')).toBeInTheDocument()
-
-    const responseTree = buildResponseTree(responses)
-    const expectedRespStatuses = Object.keys(responseTree)
-    expect(
-      screen.getAllByRole('tab', {
-        name: new RegExp(`${expectedRespStatuses.join('|')}`),
-      })
-    ).toHaveLength(expectedRespStatuses.length)
-
-    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)
-    })
-  })
-})

package/src/components/DocResponses/DocResponses.tsx

@@ -1,69 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 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 type { FC } from 'react'
-import React from 'react'
-import { Tab, TabList, TabPanel, TabPanels, useTabs } from '@looker/components'
-import type { IMethodResponse, ApiModel } from '@looker/sdk-codegen'
-
-import { CollapserCard } from '@looker/run-it'
-import { DocResponseTypes } from './DocResponseTypes'
-import { buildResponseTree } from './utils'
-
-interface DocResponsesProps {
-  responses: IMethodResponse[]
-  api: ApiModel
-}
-
-/**
- * Renders a tab list and tab panels for different method response types
- */
-export const DocResponses: FC<DocResponsesProps> = ({ api, responses }) => {
-  const tabs = useTabs()
-
-  if (responses.length === 0) return <></>
-
-  const responseTree = buildResponseTree(responses)
-
-  return (
-    <CollapserCard heading="Response Models" id="response models">
-      <>
-        <TabList {...tabs}>
-          {Object.keys(responseTree).map((statusCode, index) => (
-            <Tab key={index}>{statusCode}</Tab>
-          ))}
-        </TabList>
-        <TabPanels {...tabs} pt="0">
-          {Object.values(responseTree).map((responses, index) => (
-            <TabPanel key={index}>
-              <DocResponseTypes api={api} responses={responses} />
-            </TabPanel>
-          ))}
-        </TabPanels>
-      </>
-    </CollapserCard>
-  )
-}

package/src/utils/hooks.spec.ts

@@ -1,78 +0,0 @@
-/*
-
- 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,
-    })
-  })
-})