@looker/api-explorer 0.9.26 → 0.9.29

package/src/reducers/spec/reducer.ts

@@ -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 { SpecItem, SpecList } from '@looker/sdk-codegen'
-import { ApiModel } from '@looker/sdk-codegen'
-import type { ApiUpdatePayload } from './actions'
-import type { SpecAction } from '.'
-import { Actions } from '.'
-
-export interface SpecState {
-  specList: SpecList
-  spec: SpecItem
-}
-
-export const specReducer = (
-  state: SpecState,
-  action: SpecAction
-): SpecState => {
-  const { type, payload } = action
-  switch (type) {
-    case Actions.UPDATE_SPEC_API: {
-      const specList = { ...state.specList }
-      const { specKey, api } = payload as ApiUpdatePayload
-      let spec = specList[specKey]
-      if (spec) {
-        spec = { ...spec, api }
-        specList[specKey] = spec
-      }
-      return { specList, spec }
-    }
-    case 'SELECT_SPEC': {
-      const newState = { ...state }
-      const spec = newState.specList[payload as string]
-      // Does extension API Explorer needs this?
-      if (spec) {
-        if (!spec.api && spec.specContent) {
-          spec.api = ApiModel.fromJson(spec.specContent)
-        }
-        return { ...state, spec }
-      }
-      return state
-    }
-    default:
-      return state
-  }
-}

package/src/reducers/spec/utils.spec.ts

@@ -1,138 +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 { SpecList } from '@looker/sdk-codegen'
-import omit from 'lodash/omit'
-
-import { specs } from '../../test-data'
-import { getDefaultSpecKey, initDefaultSpecState, getSpecKey } from './utils'
-
-describe('Spec reducer utils', () => {
-  const specList: SpecList = {
-    defaultKey: {
-      key: 'defaultKey',
-      version: '4.0',
-      status: 'experimental',
-      isDefault: true,
-    },
-    deprecatedKey: {
-      key: 'deprecatedKey',
-      version: '3.0',
-      status: 'deprecated',
-      isDefault: false,
-    },
-    currentKey: {
-      key: 'currentKey',
-      version: '3.1',
-      status: 'current',
-      isDefault: false,
-    },
-    stableKey: {
-      key: 'stableKey',
-      version: '3.1',
-      status: 'stable',
-      isDefault: false,
-    },
-  }
-
-  describe('getSpecKey', () => {
-    const saveLocation = window.location
-
-    afterAll(() => {
-      window.location = saveLocation
-    })
-
-    test('recognizes spec version in url', () => {
-      window.history.pushState({}, '', '/4.0/')
-      const specKey = getSpecKey(window.location)
-      expect(specKey).toBeDefined()
-      expect(specKey).toEqual('4.0')
-    })
-
-    test('ignores oauth as a spec key', () => {
-      window.history.pushState({}, '', '/oauth/')
-      const specKey = getSpecKey(window.location)
-      expect(specKey).toEqual('')
-    })
-
-    test('gets default spec key when specs are provided and url has no path', () => {
-      window.history.pushState({}, '', '')
-      const specKey = getSpecKey(window.location, specList)
-      expect(specKey).toBeDefined()
-      expect(specKey).toEqual('defaultKey')
-    })
-
-    test('gets default spec key when specs are provided and url has oauth path', () => {
-      window.history.pushState({}, '', '/oauth/')
-      const specKey = getSpecKey(window.location, specList)
-      expect(specKey).toBeDefined()
-      expect(specKey).toEqual('defaultKey')
-    })
-  })
-
-  describe('getDefaultSpecKey', () => {
-    test('it throws if no specs are provided', () => {
-      expect(() => {
-        getDefaultSpecKey({} as SpecList)
-      }).toThrow('No specs found.')
-    })
-
-    test('it returns specKey for default spec if found', () => {
-      expect(getDefaultSpecKey(specList)).toEqual('defaultKey')
-    })
-
-    test('it returns specKey for spec marked as current if none are marked as default', () => {
-      const specItems = omit(specList, 'defaultKey')
-      expect(getDefaultSpecKey(specItems)).toEqual('currentKey')
-    })
-
-    test('it returns first spec if no spec is marked as default or current', () => {
-      const specItems = omit(specList, ['defaultKey', 'currentKey'])
-      expect(getDefaultSpecKey(specItems)).toEqual('deprecatedKey')
-    })
-  })
-
-  describe('initDefaultSpecState', () => {
-    const saveLocation = window.location
-
-    afterAll(() => {
-      window.location = saveLocation
-    })
-
-    test('it fetches spec using key defined in url', () => {
-      window.history.pushState({}, '', '/4.0/')
-      const specState = initDefaultSpecState(specs, window.location)
-      expect(specState).toBeDefined()
-      expect(specState.spec.key).toEqual('4.0')
-    })
-
-    test('it gets default spec if url does not specify a key', () => {
-      window.history.pushState({}, '', '/')
-      const specState = initDefaultSpecState(specs, window.location)
-      expect(specState).toBeDefined()
-      expect(specState.spec.key).toEqual('4.0')
-    })
-  })
-})

package/src/reducers/spec/utils.ts

@@ -1,123 +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 { SpecList } from '@looker/sdk-codegen'
-import type { Location as HLocation } from 'history'
-import { OAuthSession } from '@looker/sdk-rtl'
-import { diffPath, oAuthPath } from '../../utils'
-import type { SpecState } from './reducer'
-
-export type AbstractLocation = HLocation | Location
-
-/**
- * Given a collection of specs, it returns the spec marked as default, the one
- * marked as current or the first one, in that order.
- * @param specs A collection of specs
- * @returns A spec
- */
-export const getDefaultSpecKey = (specs: SpecList): string => {
-  const items = Object.entries(specs)
-
-  if (items.length === 0) {
-    throw Error('No specs found.')
-  }
-
-  let specKey = ''
-  items.forEach(([key, item]) => {
-    if (item.isDefault) {
-      specKey = key
-    }
-  })
-
-  if (!specKey) {
-    items.forEach(([key, item]) => {
-      if (item.status === 'current') {
-        specKey = key
-      }
-    })
-  }
-
-  if (!specKey) {
-    specKey = Object.keys(specs)[0]
-  }
-
-  if (!specKey) {
-    throw Error('No specs found.')
-  }
-
-  return specKey
-}
-
-/**
- * Determine the API specification key from URL pattern or default spec
- * @param location service to examine
- * @param specs to use to find the default spec key
- */
-export const getSpecKey = (location: AbstractLocation, specs?: SpecList) => {
-  let pathName = location.pathname
-  if (pathName === `/${oAuthPath}`) {
-    const returnUrl = sessionStorage.getItem(OAuthSession.returnUrlKey)
-    if (returnUrl) {
-      pathName = returnUrl
-    }
-  }
-  const pathNodes = pathName.split('/')
-  let specKey = ''
-  if (
-    pathNodes.length > 1 &&
-    pathNodes[1] &&
-    pathNodes[1] !== oAuthPath &&
-    pathNodes[1] !== diffPath
-  ) {
-    specKey = pathNodes[1]
-  } else if (specs) {
-    specKey = getDefaultSpecKey(specs)
-  }
-  return specKey
-}
-
-/**
- * Creates a default state object with the spec matching the specKey defined
- * in the url or the default criteria in getDefaultSpecKey
- * @param specList A collection of specs
- * @param location Standalone or extension location
- * @returns An object to be used as default state
- */
-export const initDefaultSpecState = (
-  specList: SpecList,
-  location: AbstractLocation
-): SpecState => {
-  const specKey = getSpecKey(location, specList)
-  // Handle bad spec in the URL. Fall back to 4.0
-  let spec = specList[specKey]
-  if (!spec) {
-    spec = specList['4.0']
-  }
-  return {
-    specList,
-    spec,
-  }
-}